Class ProtocolEndpoint

    • Constructor Detail

      • ProtocolEndpoint

        public ProtocolEndpoint()
    • Method Detail

      • getServiceName

        public final String getServiceName()
        Get the name of the service to which messages received by this endpoint are pre-dispatched.
        Returns:
        the name of the service, or null if message are not pre-dispatched
      • getConfigurationContext

        protected final ConfigurationContext getConfigurationContext()
        Get the Axis2 configuration context. This is a convenience method that can be used by subclasses to get the ConfigurationContext object from the listener.
        Returns:
        the configuration context
      • loadConfiguration

        public abstract boolean loadConfiguration​(ParameterInclude params)
                                           throws AxisFault
        Configure the endpoint based on the provided parameters. If no relevant parameters are found, the implementation should return false. An exception should only be thrown if there is an error or inconsistency in the parameters.
        Parameters:
        params - The source of the parameters to configure the endpoint. If the parameters are defined on a service, this will be an AxisService instance.
        Returns:
        true if the parameters contained the required configuration information and the endpoint has been configured, false if the no configuration for the endpoint is present in the parameters
        Throws:
        AxisFault - if configuration information is present, but there is an error or inconsistency in the parameters
      • getDescription

        public String getDescription()
        Get a short description of this endpoint suitable for inclusion in log messages.
        Returns:
        a short description of the endpoint