Skip navigation links
org.apache.tools.ant.taskdefs.optional.j2ee

Class AbstractHotDeploymentTool

    • Constructor Detail

      • AbstractHotDeploymentTool

        public AbstractHotDeploymentTool()
    • Method Detail

      • createClasspath

        public Path createClasspath()
        Add a classpath as a nested element.
        Returns:
        A Path object representing the classpath to be used.
      • isActionValid

        protected abstract boolean isActionValid()
        Determines if the "action" attribute defines a valid action.

        Subclasses should determine if the action passed in is supported by the vendor's deployment tool.

        Actions may by "deploy", "delete", etc... It all depends on the tool.

        Returns:
        true if the "action" attribute is valid, false if not.
      • validateAttributes

        public void validateAttributes()
                                throws BuildException
        Validates the passed in attributes. Subclasses should chain to this super-method to insure validation of boilerplate attributes.

        Only the "action" attribute is required in the base class. Subclasses should check attributes accordingly.

        Specified by:
        validateAttributes in interface HotDeploymentTool
        Throws:
        BuildException - if the attributes are invalid or incomplete.
      • deploy

        public abstract void deploy()
                             throws BuildException
        Perform the actual deployment. It's up to the subclasses to implement the actual behavior.
        Specified by:
        deploy in interface HotDeploymentTool
        Throws:
        BuildException - if the attributes are invalid or incomplete.
      • setTask

        public void setTask(ServerDeploy task)
        Sets the parent task.
        Specified by:
        setTask in interface HotDeploymentTool
        Parameters:
        task - a ServerDeploy object representing the parent task.
      • getTask

        protected ServerDeploy getTask()
        Returns the task field, a ServerDeploy object.
        Returns:
        An ServerDeploy representing the parent task.
      • getClasspath

        public Path getClasspath()
        gets the classpath field.
        Returns:
        A Path representing the "classpath" attribute.
      • setClasspath

        public void setClasspath(Path classpath)
        The classpath to be passed to the JVM running the tool; optional depending upon the tool. The classpath may also be supplied as a nested element.
        Parameters:
        classpath - A Path object representing the "classpath" attribute.
      • getUserName

        public java.lang.String getUserName()
        Returns the userName field.
        Returns:
        A String representing the "userName" attribute.
      • setUserName

        public void setUserName(java.lang.String userName)
        The user with privileges to deploy applications to the server; optional.
        Parameters:
        userName - A String representing the "userName" attribute.
      • getPassword

        public java.lang.String getPassword()
        Returns the password field.
        Returns:
        A String representing the "password" attribute.
      • setPassword

        public void setPassword(java.lang.String password)
        The password of the user; optional.
        Parameters:
        password - A String representing the "password" attribute.
      • getServer

        public java.lang.String getServer()
        Returns the server field.
        Returns:
        A String representing the "server" attribute.
      • setServer

        public void setServer(java.lang.String server)
        The address or URL for the server where the component will be deployed.
        Parameters:
        server - A String representing the "server" attribute.