Package com.sas.metadata.remote

Interface Permission

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Permission extends PrimaryType
A permission represents an action that a user may attempt against a resource in the metadata server. Permission objects are created in pairs within the metadata server. One instance will have its Type attribute set to "GRANT", the other will have Type= "DENY".

A Permission object is associated with a resource by defining an access control. The access control relates the Permission object and one or more identities with the resource on which the permission is being applied.

Permission objects should not be explicitly created or deleted. Permissions that are enforced by SAS programs are defined for you by the system. Access controls are managed programmatically using the SAS Open Metadata Interface ISecurityAdmin method class, which is documented in the SAS 9.2 Open Metadata Interface: Reference and Usage. The ISecurityAdmin class provides methods for defining and managing direct access controls as well as access control templates.

Attributes of Permission are:

Associations of Permission are:

Usage

To create an instance of this Permission, use the factory create methods.
Example: create a Permission with name "Permission_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();
 Permission myObject = (Permission) factory.createComplexMetadataObject(objectStore, "Permission_Object", MetadataObjects.PERMISSION, "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_TYPE_NAME

      static final String ATTRIBUTE_TYPE_NAME
      Constant used for the name of the Type attribute.

      Type: Type of permission

      See Also:

    • ASSOCIATION_ACCESSCONTROLENTRIES_NAME

      static final String ASSOCIATION_ACCESSCONTROLENTRIES_NAME
      Constant used for the name of the AccessControlEntries association.

      AccessControlEntries: The access control entries that use this permission.  

      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 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:
      AccessControlEntries
      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.

    • getType

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

    • getTypeState

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

    • getTypeMaxLength

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

    • getAccessControlEntries

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

    • getAccessControlEntries

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

    • setType

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

    • setType

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

    • setTypeState

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

    • setAccessControlEntries

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

    • setAccessControlEntries

      void setAccessControlEntries(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.