Class BaseCommand

    • Constructor Detail

      • BaseCommand

        public BaseCommand()
    • Method Detail

      • init

        public void init​(Session session,
                         java.util.Map<java.lang.String,​java.lang.String> parameters)
                  throws OpenAS2Exception
        Description copied from interface: Component
        Component lifecycle hook. After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.
        Specified by:
        init in interface Component
        Overrides:
        init in class BaseComponent
        Parameters:
        session - the component uses this object to access other components
        parameters - configuration values for the component
        Throws:
        OpenAS2Exception - If an error occurs while initializing the component
        See Also:
        Session
      • getDescription

        public java.lang.String getDescription()
        Specified by:
        getDescription in interface Command
      • setDescription

        public void setDescription​(java.lang.String desc)
        Specified by:
        setDescription in interface Command
      • getName

        public java.lang.String getName()
        Description copied from interface: Component
        Returns a name for the component. These names are not guaranteed to be unique, and are intended for display and logging. Generally this is the class name of the Component object, without package information.
        Specified by:
        getName in interface Command
        Specified by:
        getName in interface Component
        Overrides:
        getName in class BaseComponent
        Returns:
        name of the component
      • setName

        public void setName​(java.lang.String name)
        Specified by:
        setName in interface Command
      • getUsage

        public java.lang.String getUsage()
        Specified by:
        getUsage in interface Command
      • setUsage

        public void setUsage​(java.lang.String usage)
        Specified by:
        setUsage in interface Command
      • getDefaultName

        public abstract java.lang.String getDefaultName()
      • getDefaultDescription

        public abstract java.lang.String getDefaultDescription()
      • getDefaultUsage

        public abstract java.lang.String getDefaultUsage()