Package com.sas.metadata.remote

Interface SASClientConnection

All Superinterfaces:
CMetadata, Connection, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface SASClientConnection extends Connection
Represents the information needed by SAS software to connect to other servers.

Attributes of SASClientConnection are:

Associations of SASClientConnection are:

Usage

To create an instance of this SASClientConnection, use the factory create methods.
Example: create a SASClientConnection with name "SASClientConnection_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();
 SASClientConnection myObject = (SASClientConnection) factory.createComplexMetadataObject(objectStore, "SASClientConnection_Object", MetadataObjects.SASCLIENTCONNECTION, "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_SERVERSHORTNAME_NAME

      static final String ATTRIBUTE_SERVERSHORTNAME_NAME
      Constant used for the name of the ServerShortName attribute.

      ServerShortName: This is the short server name that is used by SAS software to access a server.

      See Also:

    • ATTRIBUTE_REMOTEADDRESS_NAME

      static final String ATTRIBUTE_REMOTEADDRESS_NAME
      Constant used for the name of the RemoteAddress attribute.

      RemoteAddress: This is the remote address to use to access the server. This can be an IP address, an IP name, or any other address acceptable to SAS software.

      See Also:

    • ATTRIBUTE_SERVICE_NAME

      static final String ATTRIBUTE_SERVICE_NAME
      Constant used for the name of the Service attribute.

      Service: This is the service name used to connect to this server.

      See Also:

    • ATTRIBUTE_PORT_NAME

      static final String ATTRIBUTE_PORT_NAME
      Constant used for the name of the Port attribute.

      Port: This is the port number to use when accessing this server.

      See Also:

    • ASSOCIATION_SCRIPTFILES_NAME

      static final String ASSOCIATION_SCRIPTFILES_NAME
      Constant used for the name of the ScriptFiles association.

      ScriptFiles: The list of files that contain connection scripts.  

      See Also:

    • ASSOCIATION_LIBRARIES_NAME

      static final String ASSOCIATION_LIBRARIES_NAME
      Constant used for the name of the Libraries association.

      Libraries: The list of SAS libraries that use this connection. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getServerShortName

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

    • getServerShortNameState

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

    • getServerShortNameMaxLength

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

    • getRemoteAddress

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

    • getRemoteAddressState

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

    • getRemoteAddressMaxLength

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

    • getService

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

    • getServiceState

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

    • getServiceMaxLength

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

    • getPort

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

    • getPortState

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

    • getScriptFiles

      AssociationList getScriptFiles() throws RemoteException, MdException
      Gets the AssociationList of ScriptFiles
      Returns:
      Returns the AssociationList of ScriptFiles which can be of type:
      File
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLibraries

      AssociationList getLibraries() throws RemoteException, MdException
      Gets the Association list of Libraries
      Returns:
      The AssociationList of Libraries which can be of type:
      SASLibrary
      SecuredLibrary
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getScriptFiles

      AssociationList getScriptFiles(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of ScriptFiles
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of ScriptFiles which can be of type:
      File
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLibraries

      AssociationList getLibraries(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Libraries
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Libraries which can be of type:
      SASLibrary
      SecuredLibrary
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setServerShortName

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

    • setServerShortName

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

    • setServerShortNameState

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

    • setRemoteAddress

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

    • setRemoteAddress

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

    • setRemoteAddressState

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

    • setService

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

    • setService

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

    • setServiceState

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

    • setPort

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

    • setPort

      void setPort(int inPort, int state) throws RemoteException
      Sets the Port Metadata State.
      Parameters:
      inPort - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPort

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

    • setPort

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

    • setPortState

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

    • setScriptFiles

      void setScriptFiles(AssociationList list) throws RemoteException
      Sets the ScriptFiles list to be list. Objects of which can be of type:
      File
      ArchiveFile
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setScriptFiles

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

    • setLibraries

      void setLibraries(AssociationList list) throws RemoteException
      Sets the Libraries list to be list. Objects of which can be of type:
      SASLibrary
      SecuredLibrary
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setLibraries

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