Package com.sas.metadata.remote

Interface AccessControl

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
AccessControlEntry, AccessControlTemplate
public interface AccessControl extends PrimaryType
An access control is an object that relates an identity and a permission to a resource in order to regulate access to the resource. The SAS Open Metadata Architecture authorization facility uses the information in access controls to return authorization decisions on resource requests.

The SAS Metadata Model defines two basic types of access controls: AccessControlEntry, which associates identities and permissions directly with a resource; and AccessControlTemplate, which enables users to define a template of identities and permissions that can be applied to multiple resources. AccessControl is a supertype and should not be instantiated. When defining an actual access control, use the AccessControlEntry and AccessControlTemplate metadata types.

AccessControl objects should not be explicitly created or deleted. 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 AccessControl are:

Associations of AccessControl are:

Usage

To create an instance of this AccessControl, use the factory create methods.
Example: create a AccessControl with name "AccessControl_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();
 AccessControl myObject = (AccessControl) factory.createComplexMetadataObject(objectStore, "AccessControl_Object", MetadataObjects.ACCESSCONTROL, "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

    • ASSOCIATION_OBJECTS_NAME

      static final String ASSOCIATION_OBJECTS_NAME
      Constant used for the name of the Objects association.

      Objects: The objects that have this access control.  

      See Also:

    • ASSOCIATION_ACCESSCONTROLTEMPLATES_NAME

      static final String ASSOCIATION_ACCESSCONTROLTEMPLATES_NAME
      Constant used for the name of the AccessControlTemplates association.

      AccessControlTemplates: The access control templates in which this access control is used. 

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

    • getObjects

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

    • getAccessControlTemplates

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

    • getObjects

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

    • getAccessControlTemplates

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

    • setObjects

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

    • setObjects

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

    • setAccessControlTemplates

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

    • setAccessControlTemplates

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