com.ibm.websphere.management.application

Class EditionInfo

  • java.lang.Object
    • com.ibm.websphere.management.application.EditionInfo
  • All Implemented Interfaces:
    java.io.Serializable

    public final class EditionInfo
extends java.lang.Object
implements java.io.Serializable
    Information related to an application edition. Use get/setEditionInfo methods on the AppManagement MBean to access and change edition information.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  EditionInfo.State
      Application edition states: ACTIVE Application edition is active (getter) or should be set to active (setter).

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String STATE_ACTIVE
      Deprecated. 
      static java.lang.String STATE_INACTIVE
      Deprecated. 
      static java.lang.String STATE_VALIDATE
      Deprecated. 

    • Constructor Summary

      Constructors 
      Constructor and Description
      EditionInfo(java.lang.String compositeName, java.lang.String cellName)
      Deprecated. 
      EditionInfo(java.lang.String cellName, java.lang.String compositeName, java.lang.String description, EditionInfo.State state) 

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getAppName()
      Returns the application name (without edition).
      java.lang.String getCellName()
      Returns the cell name.
      java.lang.String getCompositeName()
      Returns the composite application name.
      java.lang.String getDescription()
      Returns the description for the edition.
      java.lang.String getEdition()
      Returns the application edition.
      java.lang.String getEditionState()
      Deprecated. 
      EditionInfo.State getState()
      Returns the application edition's state.
      void setDescription(java.lang.String description)
      Set application edition's description.
      void setEditionState(java.lang.String state)
      Deprecated. 
      void setState(EditionInfo.State state)
      Set the application edition's state.
      java.lang.String toString()
      Returns a string representation of this object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • STATE_ACTIVE

        @Deprecated
public static final java.lang.String STATE_ACTIVE
        Deprecated. 
        Application edition is active (getter) or should be set to active (setter).
        See Also:
        Constant Field Values

      • STATE_INACTIVE

        @Deprecated
public static final java.lang.String STATE_INACTIVE
        Deprecated. 
        Application edition is inactive (getter) or should be set inactive (setter).
        See Also:
        Constant Field Values

      • STATE_VALIDATE

        @Deprecated
public static final java.lang.String STATE_VALIDATE
        Deprecated. 
        Application edition is being validated (getter) or should be set to validate (setter). Edition validation is a special case of concurrent activation. See XD documentation for more information.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EditionInfo

        @Deprecated
public EditionInfo(java.lang.String compositeName,
                      java.lang.String cellName)
        Deprecated. 

      • EditionInfo

        public EditionInfo(java.lang.String cellName,
           java.lang.String compositeName,
           java.lang.String description,
           EditionInfo.State state)

    • Method Detail

      • getCellName

        public java.lang.String getCellName()
        Returns the cell name.
        Returns:
        String cell name

      • getCompositeName

        public java.lang.String getCompositeName()
        Returns the composite application name.
        Returns:
        String composite name e.g. MyApp-edition1.2

      • getAppName

        public java.lang.String getAppName()
        Returns the application name (without edition).
        Returns:
        String application name e.g. MyApp

      • getEdition

        public java.lang.String getEdition()
        Returns the application edition.
        Returns:
        String application edition e.g. 1.2 or "" for default edition

      • getDescription

        public java.lang.String getDescription()
        Returns the description for the edition. This can be entered during edition creation by passing the -edition.desc option to the $AdminApp install command.
        Returns:
        String edition description or null

      • setDescription

        public void setDescription(java.lang.String description)
        Set application edition's description.
        Parameters:
        description - edition description

      • getState

        public EditionInfo.State getState()
        Returns the application edition's state.
        Returns:
        State edition state

      • setState

        public void setState(EditionInfo.State state)
        Set the application edition's state.
        Parameters:
        state - edition state

      • getEditionState

        @Deprecated
public java.lang.String getEditionState()
        Deprecated. 
        Returns the application edition's state. See STATE_*.
        Returns:
        String edition state
        See Also:
        getState()

      • setEditionState

        @Deprecated
public void setEditionState(java.lang.String state)
        Deprecated. 
        Set application edition state. See STATE_*.
        Parameters:
        state - edition state
        See Also:
        setState(State)

      • toString

        public java.lang.String toString()
        Returns a string representation of this object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this object.
IBM WebSphere Application ServerTM
Release 8.5