Class BaseMethod<P extends BaseParameter, T>

java.lang.Object
org.apache.felix.scr.impl.inject.methods.BaseMethod<P,T>
Direct Known Subclasses:
ActivateMethod, BindMethod
public abstract class BaseMethod<P extends BaseParameter, T> extends Object
Component method to be invoked on service (un)binding.

  • Field Details

    • dsVersion

      private final DSVersion dsVersion

    • configurableServiceProperties

      private final boolean configurableServiceProperties

    • m_methodName

      private final String m_methodName

    • m_componentClass

      private final Class<?> m_componentClass

    • m_method

      private volatile Method m_method

    • m_methodRequired

      private final boolean m_methodRequired

    • m_state

      private volatile BaseMethod.State m_state

  • Constructor Details

    • BaseMethod

      protected BaseMethod(String methodName, boolean methodRequired, Class<?> componentClass, DSVersion dsVersion, boolean configurableServiceProperties)

  • Method Details

    • getDSVersion

      protected final DSVersion getDSVersion()

    • isDS12Felix

      protected final boolean isDS12Felix()

    • getMethodName

      protected final String getMethodName()

    • getMethod

      final Method getMethod()

    • getComponentClass

      protected final Class<?> getComponentClass()

    • setTypes

      protected abstract void setTypes(T types)

    • setMethod

      void setMethod(BaseMethod.MethodInfo<T> methodInfo, ComponentLogger logger)

    • getState

      BaseMethod.State getState()

    • findMethod

      private BaseMethod.MethodInfo<T> findMethod(ComponentLogger logger) throws InvocationTargetException
      Finds the method named in the m_methodName field in the given targetClass. If the target class has no acceptable method the class hierarchy is traversed until a method is found or the root of the class hierarchy is reached without finding a method.
      Parameters:
      logger -
      Returns:
      The requested method or null if no acceptable method can be found in the target class or any super class.
      Throws:
      InvocationTargetException - If an unexpected Throwable is caught trying to find the requested method.

    • doFindMethod

      protected abstract BaseMethod.MethodInfo<T> doFindMethod(Class<?> targetClass, boolean acceptPrivate, boolean acceptPackage, ComponentLogger logger) throws SuitableMethodNotAccessibleException, InvocationTargetException
      Throws:
      SuitableMethodNotAccessibleException
      InvocationTargetException

    • getParametersForLogging

      private String[] getParametersForLogging(Object[] params)

    • invokeMethod

      private MethodResult invokeMethod(Object componentInstance, P rawParameter) throws InvocationTargetException
      Throws:
      InvocationTargetException

    • returnValue

      protected boolean returnValue()

    • getParameters

      protected abstract Object[] getParameters(Method method, P rawParameter)
      Returns the parameter array created from the rawParameter using the actual parameter type list of the method.
      Parameters:
      method -
      rawParameter -
      Returns:
      Throws:
      IllegalStateException - If the required parameters cannot be extracted from the rawParameter

    • getMethodNamePrefix

      protected String getMethodNamePrefix()

    • getMethod

      public Method getMethod(Class<?> clazz, String name, Class[] parameterTypes, boolean acceptPrivate, boolean acceptPackage, ComponentLogger logger) throws SuitableMethodNotAccessibleException, InvocationTargetException
      Finds the named public or protected method in the given class or any super class. If such a method is found, its accessibility is enfored by calling the Method.setAccessible method if required and the method is returned. Enforcing accessibility is required to support invocation of protected methods.
      Parameters:
      clazz - The Class which provides the method.
      name - The name of the method.
      parameterTypes - The parameters to the method. Passing null is equivalent to using an empty array.
      logger -
      Returns:
      The named method with enforced accessibility or null if no such method exists in the class.
      Throws:
      SuitableMethodNotAccessibleException - If method with the given name taking the parameters is found in the class but the method is not accessible.
      InvocationTargetException - If an unexpected Throwable is caught trying to access the desired method.

    • accept

      protected static boolean accept(Method method, boolean acceptPrivate, boolean acceptPackage, boolean allowReturnValue)
      Returns true if the method is acceptable to be returned from the getMethod(Class, String, Class[], boolean, boolean, ComponentLogger) and also makes the method accessible.

      This method returns true iff:

      • The method has void return type
      • Is not static
      • Is public or protected
      • Is private and acceptPrivate is true
      • Is package private and acceptPackage is true

      This method is package private for unit testing purposes. It is not meant to be called from client code.

      Parameters:
      method - The method to check
      acceptPrivate - Whether a private method is acceptable
      acceptPackage - Whether a package private method is acceptable
      allowReturnValue - whether the method can return a value (to update service registration properties)
      Returns:
      whether the method is acceptable

    • setAccessible

      private static void setAccessible(Method method)

    • getPackageName

      public static String getPackageName(Class<?> clazz)
      Returns the name of the package to which the class belongs or an empty string if the class is in the default package.

    • invoke

      public MethodResult invoke(Object componentInstance, P rawParameter, MethodResult methodCallFailureResult)
      Calls the declared method on the given component with the provided method call arguments.
      Parameters:
      componentInstance - The component instance on which to call the method
      rawParameter - The parameter container providing the actual parameters to provide to the called method
      methodCallFailureResult - The result to return from this method if calling the method resulted in an exception.
      logger -
      Returns:
      true if the method was called successfully or the method was not found and was not required. false if the method was not found but required. methodCallFailureResult is returned if the method was found and called, but the method threw an exception.

    • methodExists

      public boolean methodExists(ComponentLogger logger)