Package com.sas.metadata.remote

Interface SecuredLibrary

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, RelationalSchema, Remote, Root, SASLibrary
public interface SecuredLibrary extends SASLibrary
A SecuredLibrary object is created for a SAS physical library when it is bound to metadata with the AUTHLIB procedure of SAS. The location of the securedLibrary object is stored in the physical library such that the SAS system will not access the physical library without first establishing an authenticated identity and connection to the metadata server and obtaining the identity's data permissions for this object. These data permissions then determine what actions the SAS system will allow that identity to perform on the physical data. SecuredLibrary objects should not be created or manipulated by any code other than the AUTHLIB procedure as they will not be or will no longer be effective. The physical data will not be accessible if an existing SecuredLibrary object is modified by other means.

Attributes of SecuredLibrary are:

Associations of SecuredLibrary are:

Usage

To create an instance of this SecuredLibrary, use the factory create methods.
Example: create a SecuredLibrary with name "SecuredLibrary_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();
 SecuredLibrary myObject = (SecuredLibrary) factory.createComplexMetadataObject(objectStore, "SecuredLibrary_Object", MetadataObjects.SECUREDLIBRARY, "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_ENCRYPT_NAME

      static final String ATTRIBUTE_ENCRYPT_NAME
      Constant used for the name of the Encrypt attribute.

      Encrypt: The encrypt value for this secured library. Valid values are Y (Yes), N (No), or R (Required).

      See Also:

    • ASSOCIATION_DEFAULTPASSWORDS_NAME

      static final String ASSOCIATION_DEFAULTPASSWORDS_NAME
      Constant used for the name of the DefaultPasswords association.

      DefaultPasswords: The default passwords used by this secured library. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getEncrypt

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

    • getEncryptState

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

    • getEncryptMaxLength

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

    • getDefaultPasswords

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

    • getDefaultPasswords

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

    • setEncrypt

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

    • setEncrypt

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

    • setEncryptState

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

    • setDefaultPasswords

      void setDefaultPasswords(AssociationList list) throws RemoteException
      Sets the DefaultPasswords list to be list. Objects of which can be of type:
      SASPassword
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setDefaultPasswords

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