Package com.sas.metadata.remote

Interface TCPIPConnection

All Superinterfaces:
CMetadata, Connection, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, OpenClientConnection, PrimaryType, Remote, Root
public interface TCPIPConnection extends OpenClientConnection
Contains information for making a TCP/IP connection to a server.

Attributes of TCPIPConnection are:

Associations of TCPIPConnection are:

Usage

To create an instance of this TCPIPConnection, use the factory create methods.
Example: create a TCPIPConnection with name "TCPIPConnection_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();
 TCPIPConnection myObject = (TCPIPConnection) factory.createComplexMetadataObject(objectStore, "TCPIPConnection_Object", MetadataObjects.TCPIPCONNECTION, "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_HOSTNAME_NAME

      static final String ATTRIBUTE_HOSTNAME_NAME
      Constant used for the name of the HostName attribute.

      HostName: This is the IP name or IP address used to connect to a deployed component.

      See Also:

    • ATTRIBUTE_SERVICE_NAME

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

      Service: The name of the service to use when connecting to a server.

      See Also:

    • ATTRIBUTE_PORT_NAME

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

      Port: The port number to use to connect to the server.

      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 OpenClientConnection
      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:
      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 OpenClientConnection
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getHostName

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

    • getHostNameState

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

    • getHostNameMaxLength

      int getHostNameMaxLength() throws RemoteException
      Gets the maximum length of HostName
      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.

    • setHostName

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

    • setHostName

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

    • setHostNameState

      void setHostNameState(int state) throws RemoteException
      Sets the Metadata State of HostName.
      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.