http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6fbeb554/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.Environment.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.Environment.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.Environment.html index fb68a08..24e2e40 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.Environment.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.Environment.html @@ -609,94 +609,101 @@ <span class="sourceLineNo">601</span> // server is configured to abort.<a name="line.601"></a> <span class="sourceLineNo">602</span> abortServer(env, e);<a name="line.602"></a> <span class="sourceLineNo">603</span> } else {<a name="line.603"></a> -<span class="sourceLineNo">604</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.604"></a> -<span class="sourceLineNo">605</span> "environment because it threw: " + e,e);<a name="line.605"></a> -<span class="sourceLineNo">606</span> coprocessors.remove(env);<a name="line.606"></a> -<span class="sourceLineNo">607</span> try {<a name="line.607"></a> -<span class="sourceLineNo">608</span> shutdown(env);<a name="line.608"></a> -<span class="sourceLineNo">609</span> } catch (Exception x) {<a name="line.609"></a> -<span class="sourceLineNo">610</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.610"></a> -<span class="sourceLineNo">611</span> + env.toString() + "'", x);<a name="line.611"></a> -<span class="sourceLineNo">612</span> }<a name="line.612"></a> -<span class="sourceLineNo">613</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.613"></a> -<span class="sourceLineNo">614</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.614"></a> -<span class="sourceLineNo">615</span> "coprocessor set.", e);<a name="line.615"></a> -<span class="sourceLineNo">616</span> }<a name="line.616"></a> -<span class="sourceLineNo">617</span> }<a name="line.617"></a> -<span class="sourceLineNo">618</span><a name="line.618"></a> -<span class="sourceLineNo">619</span> /**<a name="line.619"></a> -<span class="sourceLineNo">620</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.620"></a> -<span class="sourceLineNo">621</span> * evolve coprocessor APIs.<a name="line.621"></a> -<span class="sourceLineNo">622</span> *<a name="line.622"></a> -<span class="sourceLineNo">623</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.623"></a> -<span class="sourceLineNo">624</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.625"></a> -<span class="sourceLineNo">626</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.626"></a> -<span class="sourceLineNo">627</span> *<a name="line.627"></a> -<span class="sourceLineNo">628</span> * For examples of this in action, see the implementation of<a name="line.628"></a> -<span class="sourceLineNo">629</span> * <ul><a name="line.629"></a> -<span class="sourceLineNo">630</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.630"></a> -<span class="sourceLineNo">631</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.631"></a> -<span class="sourceLineNo">632</span> * </ul><a name="line.632"></a> -<span class="sourceLineNo">633</span> *<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param clazz Coprocessor you wish to evaluate<a name="line.634"></a> -<span class="sourceLineNo">635</span> * @param methodName the name of the non-deprecated method version<a name="line.635"></a> -<span class="sourceLineNo">636</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.636"></a> -<span class="sourceLineNo">637</span> * declared.<a name="line.637"></a> -<span class="sourceLineNo">638</span> */<a name="line.638"></a> -<span class="sourceLineNo">639</span> @InterfaceAudience.Private<a name="line.639"></a> -<span class="sourceLineNo">640</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.640"></a> -<span class="sourceLineNo">641</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.641"></a> -<span class="sourceLineNo">642</span> boolean useLegacy;<a name="line.642"></a> -<span class="sourceLineNo">643</span> // Use reflection to see if they implement the non-deprecated version<a name="line.643"></a> -<span class="sourceLineNo">644</span> try {<a name="line.644"></a> -<span class="sourceLineNo">645</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.645"></a> -<span class="sourceLineNo">646</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.646"></a> -<span class="sourceLineNo">647</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.647"></a> -<span class="sourceLineNo">648</span> useLegacy = false;<a name="line.648"></a> -<span class="sourceLineNo">649</span> } catch (NoSuchMethodException exception) {<a name="line.649"></a> -<span class="sourceLineNo">650</span> useLegacy = true;<a name="line.650"></a> -<span class="sourceLineNo">651</span> } catch (SecurityException exception) {<a name="line.651"></a> -<span class="sourceLineNo">652</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.652"></a> -<span class="sourceLineNo">653</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.653"></a> -<span class="sourceLineNo">654</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.654"></a> -<span class="sourceLineNo">655</span> " and declared members of your implementation.");<a name="line.655"></a> -<span class="sourceLineNo">656</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.656"></a> +<span class="sourceLineNo">604</span> // If available, pull a table name out of the environment<a name="line.604"></a> +<span class="sourceLineNo">605</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.605"></a> +<span class="sourceLineNo">606</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.606"></a> +<span class="sourceLineNo">607</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.607"></a> +<span class="sourceLineNo">608</span> } else {<a name="line.608"></a> +<span class="sourceLineNo">609</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.609"></a> +<span class="sourceLineNo">610</span> "environment",e);<a name="line.610"></a> +<span class="sourceLineNo">611</span> }<a name="line.611"></a> +<span class="sourceLineNo">612</span><a name="line.612"></a> +<span class="sourceLineNo">613</span> coprocessors.remove(env);<a name="line.613"></a> +<span class="sourceLineNo">614</span> try {<a name="line.614"></a> +<span class="sourceLineNo">615</span> shutdown(env);<a name="line.615"></a> +<span class="sourceLineNo">616</span> } catch (Exception x) {<a name="line.616"></a> +<span class="sourceLineNo">617</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.617"></a> +<span class="sourceLineNo">618</span> + env.toString() + "'", x);<a name="line.618"></a> +<span class="sourceLineNo">619</span> }<a name="line.619"></a> +<span class="sourceLineNo">620</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.620"></a> +<span class="sourceLineNo">621</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.621"></a> +<span class="sourceLineNo">622</span> "coprocessor set.", e);<a name="line.622"></a> +<span class="sourceLineNo">623</span> }<a name="line.623"></a> +<span class="sourceLineNo">624</span> }<a name="line.624"></a> +<span class="sourceLineNo">625</span><a name="line.625"></a> +<span class="sourceLineNo">626</span> /**<a name="line.626"></a> +<span class="sourceLineNo">627</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.627"></a> +<span class="sourceLineNo">628</span> * evolve coprocessor APIs.<a name="line.628"></a> +<span class="sourceLineNo">629</span> *<a name="line.629"></a> +<span class="sourceLineNo">630</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.630"></a> +<span class="sourceLineNo">631</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.631"></a> +<span class="sourceLineNo">632</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.632"></a> +<span class="sourceLineNo">633</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.633"></a> +<span class="sourceLineNo">634</span> *<a name="line.634"></a> +<span class="sourceLineNo">635</span> * For examples of this in action, see the implementation of<a name="line.635"></a> +<span class="sourceLineNo">636</span> * <ul><a name="line.636"></a> +<span class="sourceLineNo">637</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.637"></a> +<span class="sourceLineNo">638</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.638"></a> +<span class="sourceLineNo">639</span> * </ul><a name="line.639"></a> +<span class="sourceLineNo">640</span> *<a name="line.640"></a> +<span class="sourceLineNo">641</span> * @param clazz Coprocessor you wish to evaluate<a name="line.641"></a> +<span class="sourceLineNo">642</span> * @param methodName the name of the non-deprecated method version<a name="line.642"></a> +<span class="sourceLineNo">643</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.643"></a> +<span class="sourceLineNo">644</span> * declared.<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> @InterfaceAudience.Private<a name="line.646"></a> +<span class="sourceLineNo">647</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.647"></a> +<span class="sourceLineNo">648</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.648"></a> +<span class="sourceLineNo">649</span> boolean useLegacy;<a name="line.649"></a> +<span class="sourceLineNo">650</span> // Use reflection to see if they implement the non-deprecated version<a name="line.650"></a> +<span class="sourceLineNo">651</span> try {<a name="line.651"></a> +<span class="sourceLineNo">652</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.652"></a> +<span class="sourceLineNo">653</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.653"></a> +<span class="sourceLineNo">654</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.654"></a> +<span class="sourceLineNo">655</span> useLegacy = false;<a name="line.655"></a> +<span class="sourceLineNo">656</span> } catch (NoSuchMethodException exception) {<a name="line.656"></a> <span class="sourceLineNo">657</span> useLegacy = true;<a name="line.657"></a> -<span class="sourceLineNo">658</span> }<a name="line.658"></a> -<span class="sourceLineNo">659</span> return useLegacy;<a name="line.659"></a> -<span class="sourceLineNo">660</span> }<a name="line.660"></a> -<span class="sourceLineNo">661</span><a name="line.661"></a> -<span class="sourceLineNo">662</span> /**<a name="line.662"></a> -<span class="sourceLineNo">663</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.663"></a> -<span class="sourceLineNo">664</span> */<a name="line.664"></a> -<span class="sourceLineNo">665</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.665"></a> -<span class="sourceLineNo">666</span> new ConcurrentSkipListSet<>(<a name="line.666"></a> -<span class="sourceLineNo">667</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.667"></a> -<span class="sourceLineNo">668</span> @Override<a name="line.668"></a> -<span class="sourceLineNo">669</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.669"></a> -<span class="sourceLineNo">670</span> if (c1.equals(c2)) {<a name="line.670"></a> -<span class="sourceLineNo">671</span> return 0;<a name="line.671"></a> -<span class="sourceLineNo">672</span> }<a name="line.672"></a> -<span class="sourceLineNo">673</span> return c1.getName().compareTo(c2.getName());<a name="line.673"></a> -<span class="sourceLineNo">674</span> }<a name="line.674"></a> -<span class="sourceLineNo">675</span> });<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span class="sourceLineNo">678</span> * limits the amount of logging to once per coprocessor class.<a name="line.678"></a> -<span class="sourceLineNo">679</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.679"></a> -<span class="sourceLineNo">680</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.680"></a> -<span class="sourceLineNo">681</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.681"></a> -<span class="sourceLineNo">682</span> */<a name="line.682"></a> -<span class="sourceLineNo">683</span> @InterfaceAudience.Private<a name="line.683"></a> -<span class="sourceLineNo">684</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.684"></a> -<span class="sourceLineNo">685</span> if(legacyWarning.add(clazz)) {<a name="line.685"></a> -<span class="sourceLineNo">686</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.686"></a> -<span class="sourceLineNo">687</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.687"></a> -<span class="sourceLineNo">688</span> "'. Details of the problem: " + message);<a name="line.688"></a> -<span class="sourceLineNo">689</span> }<a name="line.689"></a> -<span class="sourceLineNo">690</span> }<a name="line.690"></a> -<span class="sourceLineNo">691</span>}<a name="line.691"></a> +<span class="sourceLineNo">658</span> } catch (SecurityException exception) {<a name="line.658"></a> +<span class="sourceLineNo">659</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.659"></a> +<span class="sourceLineNo">660</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.660"></a> +<span class="sourceLineNo">661</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.661"></a> +<span class="sourceLineNo">662</span> " and declared members of your implementation.");<a name="line.662"></a> +<span class="sourceLineNo">663</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.663"></a> +<span class="sourceLineNo">664</span> useLegacy = true;<a name="line.664"></a> +<span class="sourceLineNo">665</span> }<a name="line.665"></a> +<span class="sourceLineNo">666</span> return useLegacy;<a name="line.666"></a> +<span class="sourceLineNo">667</span> }<a name="line.667"></a> +<span class="sourceLineNo">668</span><a name="line.668"></a> +<span class="sourceLineNo">669</span> /**<a name="line.669"></a> +<span class="sourceLineNo">670</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.670"></a> +<span class="sourceLineNo">671</span> */<a name="line.671"></a> +<span class="sourceLineNo">672</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.672"></a> +<span class="sourceLineNo">673</span> new ConcurrentSkipListSet<>(<a name="line.673"></a> +<span class="sourceLineNo">674</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.674"></a> +<span class="sourceLineNo">675</span> @Override<a name="line.675"></a> +<span class="sourceLineNo">676</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.676"></a> +<span class="sourceLineNo">677</span> if (c1.equals(c2)) {<a name="line.677"></a> +<span class="sourceLineNo">678</span> return 0;<a name="line.678"></a> +<span class="sourceLineNo">679</span> }<a name="line.679"></a> +<span class="sourceLineNo">680</span> return c1.getName().compareTo(c2.getName());<a name="line.680"></a> +<span class="sourceLineNo">681</span> }<a name="line.681"></a> +<span class="sourceLineNo">682</span> });<a name="line.682"></a> +<span class="sourceLineNo">683</span><a name="line.683"></a> +<span class="sourceLineNo">684</span> /**<a name="line.684"></a> +<span class="sourceLineNo">685</span> * limits the amount of logging to once per coprocessor class.<a name="line.685"></a> +<span class="sourceLineNo">686</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.686"></a> +<span class="sourceLineNo">687</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.687"></a> +<span class="sourceLineNo">688</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.688"></a> +<span class="sourceLineNo">689</span> */<a name="line.689"></a> +<span class="sourceLineNo">690</span> @InterfaceAudience.Private<a name="line.690"></a> +<span class="sourceLineNo">691</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.691"></a> +<span class="sourceLineNo">692</span> if(legacyWarning.add(clazz)) {<a name="line.692"></a> +<span class="sourceLineNo">693</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.693"></a> +<span class="sourceLineNo">694</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.694"></a> +<span class="sourceLineNo">695</span> "'. Details of the problem: " + message);<a name="line.695"></a> +<span class="sourceLineNo">696</span> }<a name="line.696"></a> +<span class="sourceLineNo">697</span> }<a name="line.697"></a> +<span class="sourceLineNo">698</span>}<a name="line.698"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6fbeb554/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.EnvironmentPriorityComparator.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.EnvironmentPriorityComparator.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.EnvironmentPriorityComparator.html index fb68a08..24e2e40 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.EnvironmentPriorityComparator.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.EnvironmentPriorityComparator.html @@ -609,94 +609,101 @@ <span class="sourceLineNo">601</span> // server is configured to abort.<a name="line.601"></a> <span class="sourceLineNo">602</span> abortServer(env, e);<a name="line.602"></a> <span class="sourceLineNo">603</span> } else {<a name="line.603"></a> -<span class="sourceLineNo">604</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.604"></a> -<span class="sourceLineNo">605</span> "environment because it threw: " + e,e);<a name="line.605"></a> -<span class="sourceLineNo">606</span> coprocessors.remove(env);<a name="line.606"></a> -<span class="sourceLineNo">607</span> try {<a name="line.607"></a> -<span class="sourceLineNo">608</span> shutdown(env);<a name="line.608"></a> -<span class="sourceLineNo">609</span> } catch (Exception x) {<a name="line.609"></a> -<span class="sourceLineNo">610</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.610"></a> -<span class="sourceLineNo">611</span> + env.toString() + "'", x);<a name="line.611"></a> -<span class="sourceLineNo">612</span> }<a name="line.612"></a> -<span class="sourceLineNo">613</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.613"></a> -<span class="sourceLineNo">614</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.614"></a> -<span class="sourceLineNo">615</span> "coprocessor set.", e);<a name="line.615"></a> -<span class="sourceLineNo">616</span> }<a name="line.616"></a> -<span class="sourceLineNo">617</span> }<a name="line.617"></a> -<span class="sourceLineNo">618</span><a name="line.618"></a> -<span class="sourceLineNo">619</span> /**<a name="line.619"></a> -<span class="sourceLineNo">620</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.620"></a> -<span class="sourceLineNo">621</span> * evolve coprocessor APIs.<a name="line.621"></a> -<span class="sourceLineNo">622</span> *<a name="line.622"></a> -<span class="sourceLineNo">623</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.623"></a> -<span class="sourceLineNo">624</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.625"></a> -<span class="sourceLineNo">626</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.626"></a> -<span class="sourceLineNo">627</span> *<a name="line.627"></a> -<span class="sourceLineNo">628</span> * For examples of this in action, see the implementation of<a name="line.628"></a> -<span class="sourceLineNo">629</span> * <ul><a name="line.629"></a> -<span class="sourceLineNo">630</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.630"></a> -<span class="sourceLineNo">631</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.631"></a> -<span class="sourceLineNo">632</span> * </ul><a name="line.632"></a> -<span class="sourceLineNo">633</span> *<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param clazz Coprocessor you wish to evaluate<a name="line.634"></a> -<span class="sourceLineNo">635</span> * @param methodName the name of the non-deprecated method version<a name="line.635"></a> -<span class="sourceLineNo">636</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.636"></a> -<span class="sourceLineNo">637</span> * declared.<a name="line.637"></a> -<span class="sourceLineNo">638</span> */<a name="line.638"></a> -<span class="sourceLineNo">639</span> @InterfaceAudience.Private<a name="line.639"></a> -<span class="sourceLineNo">640</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.640"></a> -<span class="sourceLineNo">641</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.641"></a> -<span class="sourceLineNo">642</span> boolean useLegacy;<a name="line.642"></a> -<span class="sourceLineNo">643</span> // Use reflection to see if they implement the non-deprecated version<a name="line.643"></a> -<span class="sourceLineNo">644</span> try {<a name="line.644"></a> -<span class="sourceLineNo">645</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.645"></a> -<span class="sourceLineNo">646</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.646"></a> -<span class="sourceLineNo">647</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.647"></a> -<span class="sourceLineNo">648</span> useLegacy = false;<a name="line.648"></a> -<span class="sourceLineNo">649</span> } catch (NoSuchMethodException exception) {<a name="line.649"></a> -<span class="sourceLineNo">650</span> useLegacy = true;<a name="line.650"></a> -<span class="sourceLineNo">651</span> } catch (SecurityException exception) {<a name="line.651"></a> -<span class="sourceLineNo">652</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.652"></a> -<span class="sourceLineNo">653</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.653"></a> -<span class="sourceLineNo">654</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.654"></a> -<span class="sourceLineNo">655</span> " and declared members of your implementation.");<a name="line.655"></a> -<span class="sourceLineNo">656</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.656"></a> +<span class="sourceLineNo">604</span> // If available, pull a table name out of the environment<a name="line.604"></a> +<span class="sourceLineNo">605</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.605"></a> +<span class="sourceLineNo">606</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.606"></a> +<span class="sourceLineNo">607</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.607"></a> +<span class="sourceLineNo">608</span> } else {<a name="line.608"></a> +<span class="sourceLineNo">609</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.609"></a> +<span class="sourceLineNo">610</span> "environment",e);<a name="line.610"></a> +<span class="sourceLineNo">611</span> }<a name="line.611"></a> +<span class="sourceLineNo">612</span><a name="line.612"></a> +<span class="sourceLineNo">613</span> coprocessors.remove(env);<a name="line.613"></a> +<span class="sourceLineNo">614</span> try {<a name="line.614"></a> +<span class="sourceLineNo">615</span> shutdown(env);<a name="line.615"></a> +<span class="sourceLineNo">616</span> } catch (Exception x) {<a name="line.616"></a> +<span class="sourceLineNo">617</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.617"></a> +<span class="sourceLineNo">618</span> + env.toString() + "'", x);<a name="line.618"></a> +<span class="sourceLineNo">619</span> }<a name="line.619"></a> +<span class="sourceLineNo">620</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.620"></a> +<span class="sourceLineNo">621</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.621"></a> +<span class="sourceLineNo">622</span> "coprocessor set.", e);<a name="line.622"></a> +<span class="sourceLineNo">623</span> }<a name="line.623"></a> +<span class="sourceLineNo">624</span> }<a name="line.624"></a> +<span class="sourceLineNo">625</span><a name="line.625"></a> +<span class="sourceLineNo">626</span> /**<a name="line.626"></a> +<span class="sourceLineNo">627</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.627"></a> +<span class="sourceLineNo">628</span> * evolve coprocessor APIs.<a name="line.628"></a> +<span class="sourceLineNo">629</span> *<a name="line.629"></a> +<span class="sourceLineNo">630</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.630"></a> +<span class="sourceLineNo">631</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.631"></a> +<span class="sourceLineNo">632</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.632"></a> +<span class="sourceLineNo">633</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.633"></a> +<span class="sourceLineNo">634</span> *<a name="line.634"></a> +<span class="sourceLineNo">635</span> * For examples of this in action, see the implementation of<a name="line.635"></a> +<span class="sourceLineNo">636</span> * <ul><a name="line.636"></a> +<span class="sourceLineNo">637</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.637"></a> +<span class="sourceLineNo">638</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.638"></a> +<span class="sourceLineNo">639</span> * </ul><a name="line.639"></a> +<span class="sourceLineNo">640</span> *<a name="line.640"></a> +<span class="sourceLineNo">641</span> * @param clazz Coprocessor you wish to evaluate<a name="line.641"></a> +<span class="sourceLineNo">642</span> * @param methodName the name of the non-deprecated method version<a name="line.642"></a> +<span class="sourceLineNo">643</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.643"></a> +<span class="sourceLineNo">644</span> * declared.<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> @InterfaceAudience.Private<a name="line.646"></a> +<span class="sourceLineNo">647</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.647"></a> +<span class="sourceLineNo">648</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.648"></a> +<span class="sourceLineNo">649</span> boolean useLegacy;<a name="line.649"></a> +<span class="sourceLineNo">650</span> // Use reflection to see if they implement the non-deprecated version<a name="line.650"></a> +<span class="sourceLineNo">651</span> try {<a name="line.651"></a> +<span class="sourceLineNo">652</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.652"></a> +<span class="sourceLineNo">653</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.653"></a> +<span class="sourceLineNo">654</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.654"></a> +<span class="sourceLineNo">655</span> useLegacy = false;<a name="line.655"></a> +<span class="sourceLineNo">656</span> } catch (NoSuchMethodException exception) {<a name="line.656"></a> <span class="sourceLineNo">657</span> useLegacy = true;<a name="line.657"></a> -<span class="sourceLineNo">658</span> }<a name="line.658"></a> -<span class="sourceLineNo">659</span> return useLegacy;<a name="line.659"></a> -<span class="sourceLineNo">660</span> }<a name="line.660"></a> -<span class="sourceLineNo">661</span><a name="line.661"></a> -<span class="sourceLineNo">662</span> /**<a name="line.662"></a> -<span class="sourceLineNo">663</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.663"></a> -<span class="sourceLineNo">664</span> */<a name="line.664"></a> -<span class="sourceLineNo">665</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.665"></a> -<span class="sourceLineNo">666</span> new ConcurrentSkipListSet<>(<a name="line.666"></a> -<span class="sourceLineNo">667</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.667"></a> -<span class="sourceLineNo">668</span> @Override<a name="line.668"></a> -<span class="sourceLineNo">669</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.669"></a> -<span class="sourceLineNo">670</span> if (c1.equals(c2)) {<a name="line.670"></a> -<span class="sourceLineNo">671</span> return 0;<a name="line.671"></a> -<span class="sourceLineNo">672</span> }<a name="line.672"></a> -<span class="sourceLineNo">673</span> return c1.getName().compareTo(c2.getName());<a name="line.673"></a> -<span class="sourceLineNo">674</span> }<a name="line.674"></a> -<span class="sourceLineNo">675</span> });<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span class="sourceLineNo">678</span> * limits the amount of logging to once per coprocessor class.<a name="line.678"></a> -<span class="sourceLineNo">679</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.679"></a> -<span class="sourceLineNo">680</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.680"></a> -<span class="sourceLineNo">681</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.681"></a> -<span class="sourceLineNo">682</span> */<a name="line.682"></a> -<span class="sourceLineNo">683</span> @InterfaceAudience.Private<a name="line.683"></a> -<span class="sourceLineNo">684</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.684"></a> -<span class="sourceLineNo">685</span> if(legacyWarning.add(clazz)) {<a name="line.685"></a> -<span class="sourceLineNo">686</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.686"></a> -<span class="sourceLineNo">687</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.687"></a> -<span class="sourceLineNo">688</span> "'. Details of the problem: " + message);<a name="line.688"></a> -<span class="sourceLineNo">689</span> }<a name="line.689"></a> -<span class="sourceLineNo">690</span> }<a name="line.690"></a> -<span class="sourceLineNo">691</span>}<a name="line.691"></a> +<span class="sourceLineNo">658</span> } catch (SecurityException exception) {<a name="line.658"></a> +<span class="sourceLineNo">659</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.659"></a> +<span class="sourceLineNo">660</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.660"></a> +<span class="sourceLineNo">661</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.661"></a> +<span class="sourceLineNo">662</span> " and declared members of your implementation.");<a name="line.662"></a> +<span class="sourceLineNo">663</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.663"></a> +<span class="sourceLineNo">664</span> useLegacy = true;<a name="line.664"></a> +<span class="sourceLineNo">665</span> }<a name="line.665"></a> +<span class="sourceLineNo">666</span> return useLegacy;<a name="line.666"></a> +<span class="sourceLineNo">667</span> }<a name="line.667"></a> +<span class="sourceLineNo">668</span><a name="line.668"></a> +<span class="sourceLineNo">669</span> /**<a name="line.669"></a> +<span class="sourceLineNo">670</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.670"></a> +<span class="sourceLineNo">671</span> */<a name="line.671"></a> +<span class="sourceLineNo">672</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.672"></a> +<span class="sourceLineNo">673</span> new ConcurrentSkipListSet<>(<a name="line.673"></a> +<span class="sourceLineNo">674</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.674"></a> +<span class="sourceLineNo">675</span> @Override<a name="line.675"></a> +<span class="sourceLineNo">676</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.676"></a> +<span class="sourceLineNo">677</span> if (c1.equals(c2)) {<a name="line.677"></a> +<span class="sourceLineNo">678</span> return 0;<a name="line.678"></a> +<span class="sourceLineNo">679</span> }<a name="line.679"></a> +<span class="sourceLineNo">680</span> return c1.getName().compareTo(c2.getName());<a name="line.680"></a> +<span class="sourceLineNo">681</span> }<a name="line.681"></a> +<span class="sourceLineNo">682</span> });<a name="line.682"></a> +<span class="sourceLineNo">683</span><a name="line.683"></a> +<span class="sourceLineNo">684</span> /**<a name="line.684"></a> +<span class="sourceLineNo">685</span> * limits the amount of logging to once per coprocessor class.<a name="line.685"></a> +<span class="sourceLineNo">686</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.686"></a> +<span class="sourceLineNo">687</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.687"></a> +<span class="sourceLineNo">688</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.688"></a> +<span class="sourceLineNo">689</span> */<a name="line.689"></a> +<span class="sourceLineNo">690</span> @InterfaceAudience.Private<a name="line.690"></a> +<span class="sourceLineNo">691</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.691"></a> +<span class="sourceLineNo">692</span> if(legacyWarning.add(clazz)) {<a name="line.692"></a> +<span class="sourceLineNo">693</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.693"></a> +<span class="sourceLineNo">694</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.694"></a> +<span class="sourceLineNo">695</span> "'. Details of the problem: " + message);<a name="line.695"></a> +<span class="sourceLineNo">696</span> }<a name="line.696"></a> +<span class="sourceLineNo">697</span> }<a name="line.697"></a> +<span class="sourceLineNo">698</span>}<a name="line.698"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6fbeb554/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html index fb68a08..24e2e40 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoprocessorHost.html @@ -609,94 +609,101 @@ <span class="sourceLineNo">601</span> // server is configured to abort.<a name="line.601"></a> <span class="sourceLineNo">602</span> abortServer(env, e);<a name="line.602"></a> <span class="sourceLineNo">603</span> } else {<a name="line.603"></a> -<span class="sourceLineNo">604</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.604"></a> -<span class="sourceLineNo">605</span> "environment because it threw: " + e,e);<a name="line.605"></a> -<span class="sourceLineNo">606</span> coprocessors.remove(env);<a name="line.606"></a> -<span class="sourceLineNo">607</span> try {<a name="line.607"></a> -<span class="sourceLineNo">608</span> shutdown(env);<a name="line.608"></a> -<span class="sourceLineNo">609</span> } catch (Exception x) {<a name="line.609"></a> -<span class="sourceLineNo">610</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.610"></a> -<span class="sourceLineNo">611</span> + env.toString() + "'", x);<a name="line.611"></a> -<span class="sourceLineNo">612</span> }<a name="line.612"></a> -<span class="sourceLineNo">613</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.613"></a> -<span class="sourceLineNo">614</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.614"></a> -<span class="sourceLineNo">615</span> "coprocessor set.", e);<a name="line.615"></a> -<span class="sourceLineNo">616</span> }<a name="line.616"></a> -<span class="sourceLineNo">617</span> }<a name="line.617"></a> -<span class="sourceLineNo">618</span><a name="line.618"></a> -<span class="sourceLineNo">619</span> /**<a name="line.619"></a> -<span class="sourceLineNo">620</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.620"></a> -<span class="sourceLineNo">621</span> * evolve coprocessor APIs.<a name="line.621"></a> -<span class="sourceLineNo">622</span> *<a name="line.622"></a> -<span class="sourceLineNo">623</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.623"></a> -<span class="sourceLineNo">624</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.625"></a> -<span class="sourceLineNo">626</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.626"></a> -<span class="sourceLineNo">627</span> *<a name="line.627"></a> -<span class="sourceLineNo">628</span> * For examples of this in action, see the implementation of<a name="line.628"></a> -<span class="sourceLineNo">629</span> * <ul><a name="line.629"></a> -<span class="sourceLineNo">630</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.630"></a> -<span class="sourceLineNo">631</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.631"></a> -<span class="sourceLineNo">632</span> * </ul><a name="line.632"></a> -<span class="sourceLineNo">633</span> *<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param clazz Coprocessor you wish to evaluate<a name="line.634"></a> -<span class="sourceLineNo">635</span> * @param methodName the name of the non-deprecated method version<a name="line.635"></a> -<span class="sourceLineNo">636</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.636"></a> -<span class="sourceLineNo">637</span> * declared.<a name="line.637"></a> -<span class="sourceLineNo">638</span> */<a name="line.638"></a> -<span class="sourceLineNo">639</span> @InterfaceAudience.Private<a name="line.639"></a> -<span class="sourceLineNo">640</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.640"></a> -<span class="sourceLineNo">641</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.641"></a> -<span class="sourceLineNo">642</span> boolean useLegacy;<a name="line.642"></a> -<span class="sourceLineNo">643</span> // Use reflection to see if they implement the non-deprecated version<a name="line.643"></a> -<span class="sourceLineNo">644</span> try {<a name="line.644"></a> -<span class="sourceLineNo">645</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.645"></a> -<span class="sourceLineNo">646</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.646"></a> -<span class="sourceLineNo">647</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.647"></a> -<span class="sourceLineNo">648</span> useLegacy = false;<a name="line.648"></a> -<span class="sourceLineNo">649</span> } catch (NoSuchMethodException exception) {<a name="line.649"></a> -<span class="sourceLineNo">650</span> useLegacy = true;<a name="line.650"></a> -<span class="sourceLineNo">651</span> } catch (SecurityException exception) {<a name="line.651"></a> -<span class="sourceLineNo">652</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.652"></a> -<span class="sourceLineNo">653</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.653"></a> -<span class="sourceLineNo">654</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.654"></a> -<span class="sourceLineNo">655</span> " and declared members of your implementation.");<a name="line.655"></a> -<span class="sourceLineNo">656</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.656"></a> +<span class="sourceLineNo">604</span> // If available, pull a table name out of the environment<a name="line.604"></a> +<span class="sourceLineNo">605</span> if(env instanceof RegionCoprocessorEnvironment) {<a name="line.605"></a> +<span class="sourceLineNo">606</span> String tableName = ((RegionCoprocessorEnvironment)env).getRegionInfo().getTable().getNameAsString();<a name="line.606"></a> +<span class="sourceLineNo">607</span> LOG.error("Removing coprocessor '" + env.toString() + "' from table '"+ tableName + "'", e);<a name="line.607"></a> +<span class="sourceLineNo">608</span> } else {<a name="line.608"></a> +<span class="sourceLineNo">609</span> LOG.error("Removing coprocessor '" + env.toString() + "' from " +<a name="line.609"></a> +<span class="sourceLineNo">610</span> "environment",e);<a name="line.610"></a> +<span class="sourceLineNo">611</span> }<a name="line.611"></a> +<span class="sourceLineNo">612</span><a name="line.612"></a> +<span class="sourceLineNo">613</span> coprocessors.remove(env);<a name="line.613"></a> +<span class="sourceLineNo">614</span> try {<a name="line.614"></a> +<span class="sourceLineNo">615</span> shutdown(env);<a name="line.615"></a> +<span class="sourceLineNo">616</span> } catch (Exception x) {<a name="line.616"></a> +<span class="sourceLineNo">617</span> LOG.error("Uncaught exception when shutting down coprocessor '"<a name="line.617"></a> +<span class="sourceLineNo">618</span> + env.toString() + "'", x);<a name="line.618"></a> +<span class="sourceLineNo">619</span> }<a name="line.619"></a> +<span class="sourceLineNo">620</span> throw new DoNotRetryIOException("Coprocessor: '" + env.toString() +<a name="line.620"></a> +<span class="sourceLineNo">621</span> "' threw: '" + e + "' and has been removed from the active " +<a name="line.621"></a> +<span class="sourceLineNo">622</span> "coprocessor set.", e);<a name="line.622"></a> +<span class="sourceLineNo">623</span> }<a name="line.623"></a> +<span class="sourceLineNo">624</span> }<a name="line.624"></a> +<span class="sourceLineNo">625</span><a name="line.625"></a> +<span class="sourceLineNo">626</span> /**<a name="line.626"></a> +<span class="sourceLineNo">627</span> * Used to gracefully handle fallback to deprecated methods when we<a name="line.627"></a> +<span class="sourceLineNo">628</span> * evolve coprocessor APIs.<a name="line.628"></a> +<span class="sourceLineNo">629</span> *<a name="line.629"></a> +<span class="sourceLineNo">630</span> * When a particular Coprocessor API is updated to change methods, hosts can support fallback<a name="line.630"></a> +<span class="sourceLineNo">631</span> * to the deprecated API by using this method to determine if an instance implements the new API.<a name="line.631"></a> +<span class="sourceLineNo">632</span> * In the event that said support is partial, then in the face of a runtime issue that prevents<a name="line.632"></a> +<span class="sourceLineNo">633</span> * proper operation {@link #legacyWarning(Class, String)} should be used to let operators know.<a name="line.633"></a> +<span class="sourceLineNo">634</span> *<a name="line.634"></a> +<span class="sourceLineNo">635</span> * For examples of this in action, see the implementation of<a name="line.635"></a> +<span class="sourceLineNo">636</span> * <ul><a name="line.636"></a> +<span class="sourceLineNo">637</span> * <li>{@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost}<a name="line.637"></a> +<span class="sourceLineNo">638</span> * <li>{@link org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost}<a name="line.638"></a> +<span class="sourceLineNo">639</span> * </ul><a name="line.639"></a> +<span class="sourceLineNo">640</span> *<a name="line.640"></a> +<span class="sourceLineNo">641</span> * @param clazz Coprocessor you wish to evaluate<a name="line.641"></a> +<span class="sourceLineNo">642</span> * @param methodName the name of the non-deprecated method version<a name="line.642"></a> +<span class="sourceLineNo">643</span> * @param parameterTypes the Class of the non-deprecated method's arguments in the order they are<a name="line.643"></a> +<span class="sourceLineNo">644</span> * declared.<a name="line.644"></a> +<span class="sourceLineNo">645</span> */<a name="line.645"></a> +<span class="sourceLineNo">646</span> @InterfaceAudience.Private<a name="line.646"></a> +<span class="sourceLineNo">647</span> protected static boolean useLegacyMethod(final Class<? extends Coprocessor> clazz,<a name="line.647"></a> +<span class="sourceLineNo">648</span> final String methodName, final Class<?>... parameterTypes) {<a name="line.648"></a> +<span class="sourceLineNo">649</span> boolean useLegacy;<a name="line.649"></a> +<span class="sourceLineNo">650</span> // Use reflection to see if they implement the non-deprecated version<a name="line.650"></a> +<span class="sourceLineNo">651</span> try {<a name="line.651"></a> +<span class="sourceLineNo">652</span> clazz.getDeclaredMethod(methodName, parameterTypes);<a name="line.652"></a> +<span class="sourceLineNo">653</span> LOG.debug("Found an implementation of '" + methodName + "' that uses updated method " +<a name="line.653"></a> +<span class="sourceLineNo">654</span> "signature. Skipping legacy support for invocations in '" + clazz +"'.");<a name="line.654"></a> +<span class="sourceLineNo">655</span> useLegacy = false;<a name="line.655"></a> +<span class="sourceLineNo">656</span> } catch (NoSuchMethodException exception) {<a name="line.656"></a> <span class="sourceLineNo">657</span> useLegacy = true;<a name="line.657"></a> -<span class="sourceLineNo">658</span> }<a name="line.658"></a> -<span class="sourceLineNo">659</span> return useLegacy;<a name="line.659"></a> -<span class="sourceLineNo">660</span> }<a name="line.660"></a> -<span class="sourceLineNo">661</span><a name="line.661"></a> -<span class="sourceLineNo">662</span> /**<a name="line.662"></a> -<span class="sourceLineNo">663</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.663"></a> -<span class="sourceLineNo">664</span> */<a name="line.664"></a> -<span class="sourceLineNo">665</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.665"></a> -<span class="sourceLineNo">666</span> new ConcurrentSkipListSet<>(<a name="line.666"></a> -<span class="sourceLineNo">667</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.667"></a> -<span class="sourceLineNo">668</span> @Override<a name="line.668"></a> -<span class="sourceLineNo">669</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.669"></a> -<span class="sourceLineNo">670</span> if (c1.equals(c2)) {<a name="line.670"></a> -<span class="sourceLineNo">671</span> return 0;<a name="line.671"></a> -<span class="sourceLineNo">672</span> }<a name="line.672"></a> -<span class="sourceLineNo">673</span> return c1.getName().compareTo(c2.getName());<a name="line.673"></a> -<span class="sourceLineNo">674</span> }<a name="line.674"></a> -<span class="sourceLineNo">675</span> });<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span class="sourceLineNo">678</span> * limits the amount of logging to once per coprocessor class.<a name="line.678"></a> -<span class="sourceLineNo">679</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.679"></a> -<span class="sourceLineNo">680</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.680"></a> -<span class="sourceLineNo">681</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.681"></a> -<span class="sourceLineNo">682</span> */<a name="line.682"></a> -<span class="sourceLineNo">683</span> @InterfaceAudience.Private<a name="line.683"></a> -<span class="sourceLineNo">684</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.684"></a> -<span class="sourceLineNo">685</span> if(legacyWarning.add(clazz)) {<a name="line.685"></a> -<span class="sourceLineNo">686</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.686"></a> -<span class="sourceLineNo">687</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.687"></a> -<span class="sourceLineNo">688</span> "'. Details of the problem: " + message);<a name="line.688"></a> -<span class="sourceLineNo">689</span> }<a name="line.689"></a> -<span class="sourceLineNo">690</span> }<a name="line.690"></a> -<span class="sourceLineNo">691</span>}<a name="line.691"></a> +<span class="sourceLineNo">658</span> } catch (SecurityException exception) {<a name="line.658"></a> +<span class="sourceLineNo">659</span> LOG.warn("The Security Manager denied our attempt to detect if the coprocessor '" + clazz +<a name="line.659"></a> +<span class="sourceLineNo">660</span> "' requires legacy support; assuming it does. If you get later errors about legacy " +<a name="line.660"></a> +<span class="sourceLineNo">661</span> "coprocessor use, consider updating your security policy to allow access to the package" +<a name="line.661"></a> +<span class="sourceLineNo">662</span> " and declared members of your implementation.");<a name="line.662"></a> +<span class="sourceLineNo">663</span> LOG.debug("Details of Security Manager rejection.", exception);<a name="line.663"></a> +<span class="sourceLineNo">664</span> useLegacy = true;<a name="line.664"></a> +<span class="sourceLineNo">665</span> }<a name="line.665"></a> +<span class="sourceLineNo">666</span> return useLegacy;<a name="line.666"></a> +<span class="sourceLineNo">667</span> }<a name="line.667"></a> +<span class="sourceLineNo">668</span><a name="line.668"></a> +<span class="sourceLineNo">669</span> /**<a name="line.669"></a> +<span class="sourceLineNo">670</span> * Used to limit legacy handling to once per Coprocessor class per classloader.<a name="line.670"></a> +<span class="sourceLineNo">671</span> */<a name="line.671"></a> +<span class="sourceLineNo">672</span> private static final Set<Class<? extends Coprocessor>> legacyWarning =<a name="line.672"></a> +<span class="sourceLineNo">673</span> new ConcurrentSkipListSet<>(<a name="line.673"></a> +<span class="sourceLineNo">674</span> new Comparator<Class<? extends Coprocessor>>() {<a name="line.674"></a> +<span class="sourceLineNo">675</span> @Override<a name="line.675"></a> +<span class="sourceLineNo">676</span> public int compare(Class<? extends Coprocessor> c1, Class<? extends Coprocessor> c2) {<a name="line.676"></a> +<span class="sourceLineNo">677</span> if (c1.equals(c2)) {<a name="line.677"></a> +<span class="sourceLineNo">678</span> return 0;<a name="line.678"></a> +<span class="sourceLineNo">679</span> }<a name="line.679"></a> +<span class="sourceLineNo">680</span> return c1.getName().compareTo(c2.getName());<a name="line.680"></a> +<span class="sourceLineNo">681</span> }<a name="line.681"></a> +<span class="sourceLineNo">682</span> });<a name="line.682"></a> +<span class="sourceLineNo">683</span><a name="line.683"></a> +<span class="sourceLineNo">684</span> /**<a name="line.684"></a> +<span class="sourceLineNo">685</span> * limits the amount of logging to once per coprocessor class.<a name="line.685"></a> +<span class="sourceLineNo">686</span> * Used in concert with {@link #useLegacyMethod(Class, String, Class[])} when a runtime issue<a name="line.686"></a> +<span class="sourceLineNo">687</span> * prevents properly supporting the legacy version of a coprocessor API.<a name="line.687"></a> +<span class="sourceLineNo">688</span> * Since coprocessors can be in tight loops this serves to limit the amount of log spam we create.<a name="line.688"></a> +<span class="sourceLineNo">689</span> */<a name="line.689"></a> +<span class="sourceLineNo">690</span> @InterfaceAudience.Private<a name="line.690"></a> +<span class="sourceLineNo">691</span> protected void legacyWarning(final Class<? extends Coprocessor> clazz, final String message) {<a name="line.691"></a> +<span class="sourceLineNo">692</span> if(legacyWarning.add(clazz)) {<a name="line.692"></a> +<span class="sourceLineNo">693</span> LOG.error("You have a legacy coprocessor loaded and there are events we can't map to the " +<a name="line.693"></a> +<span class="sourceLineNo">694</span> " deprecated API. Your coprocessor will not see these events. Please update '" + clazz +<a name="line.694"></a> +<span class="sourceLineNo">695</span> "'. Details of the problem: " + message);<a name="line.695"></a> +<span class="sourceLineNo">696</span> }<a name="line.696"></a> +<span class="sourceLineNo">697</span> }<a name="line.697"></a> +<span class="sourceLineNo">698</span>}<a name="line.698"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6fbeb554/devapidocs/src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html index 98e0fea..b344d66 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure/ZKProcedureMemberRpcs.html @@ -133,7 +133,7 @@ <span class="sourceLineNo">125</span> * @param path full znode path that cause the notification<a name="line.125"></a> <span class="sourceLineNo">126</span> */<a name="line.126"></a> <span class="sourceLineNo">127</span> private void receivedReachedGlobalBarrier(String path) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> LOG.debug("Recieved reached global barrier:" + path);<a name="line.128"></a> +<span class="sourceLineNo">128</span> LOG.debug("Received reached global barrier:" + path);<a name="line.128"></a> <span class="sourceLineNo">129</span> String procName = ZKUtil.getNodeName(path);<a name="line.129"></a> <span class="sourceLineNo">130</span> this.member.receivedReachedGlobalBarrier(procName);<a name="line.130"></a> <span class="sourceLineNo">131</span> }<a name="line.131"></a>
