Package com.sas.metadata.remote

Interface ServiceType

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface ServiceType extends SecondaryType
The types of services available from a DeployedComponent. Examples of types are DBMS, FileSystem, OperatingSystem.

Attributes of ServiceType are:

Associations of ServiceType are:

Usage

To create an instance of this ServiceType, use the factory create methods.
Example: create a ServiceType with name "ServiceType_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 ServiceType myObject = (ServiceType) factory.createComplexMetadataObject(objectStore, "ServiceType_Object", MetadataObjects.SERVICETYPE, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_INTERFACENAME_NAME

      static final String ATTRIBUTE_INTERFACENAME_NAME
      Constant used for the name of the InterfaceName attribute.

      InterfaceName: Name of the interface of the component that provides this type of service.

      See Also:

    • ATTRIBUTE_CLASSIDENTIFIER_NAME

      static final String ATTRIBUTE_CLASSIDENTIFIER_NAME
      Constant used for the name of the ClassIdentifier attribute.

      ClassIdentifier: The class identifier is a unique identifier for this component. If this is a Java component, it is the full name of the Java class.

      See Also:

    • ASSOCIATION_DEPLOYEDCOMPONENTS_NAME

      static final String ASSOCIATION_DEPLOYEDCOMPONENTS_NAME
      Constant used for the name of the DeployedComponents association.

      DeployedComponents: The deployed components that provide this type of service. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getInterfaceName

      String getInterfaceName() throws RemoteException
      Gets the String value of InterfaceName
      Returns:
      The InterfaceName
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getInterfaceNameState

      int getInterfaceNameState() throws RemoteException
      Gets the Metadata State of InterfaceName
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getInterfaceNameMaxLength

      int getInterfaceNameMaxLength() throws RemoteException
      Gets the maximum length of InterfaceName
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getClassIdentifier

      String getClassIdentifier() throws RemoteException
      Gets the String value of ClassIdentifier
      Returns:
      The ClassIdentifier
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getClassIdentifierState

      int getClassIdentifierState() throws RemoteException
      Gets the Metadata State of ClassIdentifier
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getClassIdentifierMaxLength

      int getClassIdentifierMaxLength() throws RemoteException
      Gets the maximum length of ClassIdentifier
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getDeployedComponents

      AssociationList getDeployedComponents() throws RemoteException, MdException
      Gets the Association list of DeployedComponents
      Returns:
      The AssociationList of DeployedComponents which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getDeployedComponents

      AssociationList getDeployedComponents(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of DeployedComponents
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the DeployedComponents which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setInterfaceName

      void setInterfaceName(String inInterfaceName) throws RemoteException
      Sets the InterfaceName value and sets the state to MetadataState.LOCAL.
      Parameters:
      inInterfaceName - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setInterfaceName

      void setInterfaceName(String inInterfaceName, int state) throws RemoteException
      Sets the InterfaceName Metadata State.
      Parameters:
      inInterfaceName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setInterfaceNameState

      void setInterfaceNameState(int state) throws RemoteException
      Sets the Metadata State of InterfaceName.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setClassIdentifier

      void setClassIdentifier(String inClassIdentifier) throws RemoteException
      Sets the ClassIdentifier value and sets the state to MetadataState.LOCAL.
      Parameters:
      inClassIdentifier - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setClassIdentifier

      void setClassIdentifier(String inClassIdentifier, int state) throws RemoteException
      Sets the ClassIdentifier Metadata State.
      Parameters:
      inClassIdentifier - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setClassIdentifierState

      void setClassIdentifierState(int state) throws RemoteException
      Sets the Metadata State of ClassIdentifier.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setDeployedComponents

      void setDeployedComponents(AssociationList list) throws RemoteException
      Sets the DeployedComponents list to be list. Objects of which can be of type:
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setDeployedComponents

      void setDeployedComponents(AssociationList inObjects, int state) throws RemoteException
      Sets the entire DeployedComponents list to match the passed in AssociationList, sets the state of the DeployedComponents
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.