Package com.sas.metadata.remote

Interface ServiceComponent

All Superinterfaces:
CMetadata, ConfiguredComponent, DeployedComponent, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, SoftwareComponent
public interface ServiceComponent extends ConfiguredComponent
Represents software that acts as a service.

Attributes of ServiceComponent are:

Associations of ServiceComponent are:

Usage

To create an instance of this ServiceComponent, use the factory create methods.
Example: create a ServiceComponent with name "ServiceComponent_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();
 ServiceComponent myObject = (ServiceComponent) factory.createComplexMetadataObject(objectStore, "ServiceComponent_Object", MetadataObjects.SERVICECOMPONENT, "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_ISREMOTELYACCESSIBLE_NAME

      static final String ATTRIBUTE_ISREMOTELYACCESSIBLE_NAME
      Constant used for the name of the IsRemotelyAccessible attribute.

      IsRemotelyAccessible: Specifies whether or not the service is remotely accessible (i.e. whether it is capable of servicing a client operating in a distributed environment).

      See Also:

    • ATTRIBUTE_FACTORYCLASSNAME_NAME

      static final String ATTRIBUTE_FACTORYCLASSNAME_NAME
      Constant used for the name of the FactoryClassName attribute.

      FactoryClassName: Specifies the fully-qualified name of the class that serves as the factory for instantiating the service (i.e. com.sas.services.Information.InformationServiceFactory).

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface ConfiguredComponent
      Specified by:
      initializeRequiredObjects in interface DeployedComponent
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SoftwareComponent
      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 ConfiguredComponent
      Specified by:
      initializePredObjects in interface DeployedComponent
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SoftwareComponent
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsRemotelyAccessible

      int getIsRemotelyAccessible() throws RemoteException
      Gets the int value of IsRemotelyAccessible
      Returns:
      The IsRemotelyAccessible
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsRemotelyAccessibleState

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

    • getFactoryClassName

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

    • getFactoryClassNameState

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

    • getFactoryClassNameMaxLength

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

    • setIsRemotelyAccessible

      void setIsRemotelyAccessible(int inIsRemotelyAccessible) throws RemoteException
      Sets the IsRemotelyAccessible value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsRemotelyAccessible - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRemotelyAccessible

      void setIsRemotelyAccessible(int inIsRemotelyAccessible, int state) throws RemoteException
      Sets the IsRemotelyAccessible Metadata State.
      Parameters:
      inIsRemotelyAccessible - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRemotelyAccessible

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

    • setIsRemotelyAccessible

      void setIsRemotelyAccessible(String inIsRemotelyAccessible, int state) throws RemoteException
      Sets the IsRemotelyAccessible value and Metadata State.
      Parameters:
      inIsRemotelyAccessible - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRemotelyAccessibleState

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

    • setFactoryClassName

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

    • setFactoryClassName

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

    • setFactoryClassNameState

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