Package com.sas.metadata.remote

Interface SecurityRule

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
SecurityTypeContainmentRule
public interface SecurityRule extends SecondaryType
This is an abstract class from which other "SecurityRules" will derive. Security rules are used to tell the authorization facility the rules it should use when making authorization decisions.

Attributes of SecurityRule are:

Associations of SecurityRule are:

Usage

To create an instance of this SecurityRule, use the factory create methods.
Example: create a SecurityRule with name "SecurityRule_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();
 SecurityRule myObject = (SecurityRule) factory.createComplexMetadataObject(objectStore, "SecurityRule_Object", MetadataObjects.SECURITYRULE, "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_RULE_NAME

      static final String ATTRIBUTE_RULE_NAME
      Constant used for the name of the Rule attribute.

      Rule: Rule

      See Also:

    • ATTRIBUTE_TYPE_NAME

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

      Type: Used to indicate the category of the particular rule.

      See Also:

    • ASSOCIATION_SECRULESCHEME_NAME

      static final String ASSOCIATION_SECRULESCHEME_NAME
      Constant used for the name of the SecRuleScheme association.

      SecRuleScheme: The security rule scheme that contains this rule.  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getRule

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

    • getRuleState

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

    • getRuleMaxLength

      int getRuleMaxLength() throws RemoteException
      Gets the maximum length of Rule
      Returns:
      The max size
      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.

    • getSecRuleSchemes

      AssociationList getSecRuleSchemes() throws RemoteException, MdException
      Gets the AssociationList of SecRuleSchemes
      Returns:
      Returns the AssociationList of SecRuleSchemes which can be of type:
      SecurityRuleScheme
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getSecRuleScheme

      SecurityRuleScheme getSecRuleScheme() throws RemoteException, MdException
      Gets the SecurityRuleScheme for SecRuleScheme
      Returns:
      The SecurityRuleScheme ( null if not set) of SecRuleSchemewhich can be of type:
      SecurityRuleScheme
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSecRuleSchemes

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

    • setRule

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

    • setRule

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

    • setRuleState

      void setRuleState(int state) throws RemoteException
      Sets the Metadata State of Rule.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote 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.

    • setSecRuleSchemes

      void setSecRuleSchemes(AssociationList list) throws RemoteException
      Sets the SecRuleSchemes list to be list. Object of which can be of type:
      SecurityRuleScheme
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSecRuleSchemes

      void setSecRuleSchemes(AssociationList list, int state) throws RemoteException
      Sets the SecRuleSchemes list to be list. Object of which can be of type:
      SecurityRuleScheme
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSecRuleScheme

      void setSecRuleScheme(SecurityRuleScheme inObject) throws RemoteException
      Sets the SecRuleSchemes list 0th element to be inObject.
      Parameters:
      inObject - SecurityRuleScheme
      Throws:
      RemoteException - If error communicating with remote object.