Interface ApplicationInformation<T>

  • Type Parameters:
    T - This is the type of data that this application stores for the handler

    public interface ApplicationInformation<T>
    This interface defines methods for accessing information about an application such as it's name and location.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object getConfigProperty​(java.lang.String propName)
      This returns the value of a property in the application configuration.
      com.ibm.wsspi.adaptable.module.Container getContainer()
      This is the container that has been created for this application.
      T getHandlerInfo()
      This returns any information that the application handler has associated with this application.
      java.lang.String getLocation()
      Returns the location of the application.
      java.lang.String getName()
      Returns the name of the application as defined in the server configuration
      java.lang.String getPid()
      Returns the PID of the application as defined in the server configuration
      boolean getUseJandex()
      This indicates whether Jandex annotation indexes supplied in the application are to be used.
      void setContainer​(com.ibm.wsspi.adaptable.module.Container container)
      This method will set a new Container onto this application.
      void setHandlerInfo​(T handlerInfo)  
    • Method Detail

      • getPid

        java.lang.String getPid()
        Returns the PID of the application as defined in the server configuration
        Returns:
        The PID
      • getName

        java.lang.String getName()
        Returns the name of the application as defined in the server configuration
        Returns:
        The name
      • getLocation

        java.lang.String getLocation()
        Returns the location of the application. This should be the fully qualified absolute path to the application unless this was not available
        Returns:
        The location
      • getContainer

        com.ibm.wsspi.adaptable.module.Container getContainer()

        This is the container that has been created for this application.

        By default this will be set to a container created on the location on disk of this application. If the getLocation() does not return an absolute location on disk this will return null. The return value can be specified by ApplicationHandlers in the setContainer(Container) method.

        Returns:
        The container for the application
      • setContainer

        void setContainer​(com.ibm.wsspi.adaptable.module.Container container)

        This method will set a new Container onto this application. This allows ApplicationHandlers that work with an adapted (typically an InterpretedContainer) version of a container to only have to create it once and associate it with this application instance.

        The container for this application will be used to monitor when the application has been deleted so if this method is used the new container should still be for the location on disk that will be used by the user.

        Parameters:
        container - The new container for this application
      • getConfigProperty

        java.lang.Object getConfigProperty​(java.lang.String propName)
        This returns the value of a property in the application configuration.
        Parameters:
        propName -
        Returns:
        The value of the property.
      • getHandlerInfo

        T getHandlerInfo()
        This returns any information that the application handler has associated with this application.
        Returns:
        The application handler information
      • setHandlerInfo

        void setHandlerInfo​(T handlerInfo)
        Parameters:
        handlerInfo - The application handler information
      • getUseJandex

        boolean getUseJandex()
        This indicates whether Jandex annotation indexes supplied in the application are to be used.
        Returns: