com.filenet.wcm.toolkit.util
Class WcmSecurityAccessUtil

java.lang.Object
  extended bycom.filenet.wcm.toolkit.util.WcmSecurityAccessUtil

Deprecated. This class has been deprecated since the security model has been changed. Please use com.filenet.wcm.toolkit.util.security.WcmSecurityAccessUtil

public class WcmSecurityAccessUtil
extends java.lang.Object

The WcmSecurityAccessUtil class is a utility to compute the object security for the client application.


Field Summary
protected  int[] accessLevels
          Deprecated. Hold the security access levels.
protected static int ADD_TO_FOLDER
          Deprecated. This constant defines the Add To Folder Access Level mask.
static int ADVANCE_SETTINGS
          Deprecated. This constant indicates an Advanced System Defined Settings state.
protected  int allow
          Deprecated. Bit field indicating access allow rights.
protected static int CUSTOMOBJECT_MODIFY_PROPERTIES
          Deprecated. This constant defines the Custom Object Modify Properties Access Level mask.
protected static int CUSTOMOBJECT_OWNER_CONTROL
          Deprecated. This constant defines the Custom Object Owner Control Access Level mask.
protected static int DEFAULT_CUSTOMOBJECT_ALLOW_ACCESS
          Deprecated. This constant defines the custom object object default access right of a new grantee.
protected static int DEFAULT_DOCUMENT_ALLOW_ACCESS
          Deprecated. This constant defines the document object default access right of a new grantee.
protected static int DEFAULT_FOLDER_ALLOW_ACCESS
          Deprecated. This constant defines the folder object default access right of a new grantee.
protected static int DEFAULT_MODIFY_PROPERTIES
          Deprecated. This constant defines the default Modify Properties Access Level mask.
protected static int DEFAULT_OWNER_CONTROL
          Deprecated. This constant defines the default Owner Control Access Level mask.
protected static int DEFAULT_SEARCH_ALLOW_ACCESS
          Deprecated. This constant defines the search/publish template object default access right of a new grantee.
protected static int DEFAULT_WORKFLOW_SUBSCRIPTION_ALLOW_ACCESS
          Deprecated. This constant defines the workflow subscription object default access right of a new grantee.
protected  int deny
          Deprecated. Bit field indicating access deny rights.
static int DENY
          Deprecated. This constant indicates a deny state.
protected static int DOCUMENT_MODIFY_CONTENT
          Deprecated. This constant defines the Document Modify Content Access Level mask.
protected static int DOCUMENT_MODIFY_PROPERTIES
          Deprecated. This constant defines the Document Modify Properties Access Level mask.
protected static int DOCUMENT_OWNER_CONTROL
          Deprecated. This constant defines the Document Owner Control Access Level mask.
protected static int FOLDER_MODIFY_PROPERTIES
          Deprecated. This constant defines the Folder Modify Properties Access Level mask.
protected static int FOLDER_OWNER_CONTROL
          Deprecated. This constant defines the Folder Owner Control Access Level mask.
static int GRANT
          Deprecated. This constant indicates a grant state.
static int INHERITED_DENY
          Deprecated. This constant indicates a deny state through inheritance.
static int INHERITED_GRANT
          Deprecated. This constant indicates a grant state through inheritance.
protected  int inheritedAllow
          Deprecated. Bit field indicating inherited access allow rights.
protected  int inheritedDeny
          Deprecated. Bit field indicating inherited access deny rights.
static java.lang.String NAME_ADDTOFOLDER
          Deprecated. This constant specifies the Add To Folder access name.
static java.lang.String NAME_MODIFYCONTENT
          Deprecated. This constant specifies the Modify Content access name.
static java.lang.String NAME_MODIFYPROPS
          Deprecated. This constant specifies the Modify Properties access name.
static java.lang.String NAME_OWNERCTRL
          Deprecated. This constant specifies the Owner Control access name.
static java.lang.String NAME_PROMOTEVERSION
          Deprecated. This constant specifies the Promote Version access name.
static java.lang.String NAME_PUBLISH
          Deprecated. This constant specifies the Publish access name.
static java.lang.String NAME_VIEWCONTENT
          Deprecated. This constant specifies the View Content access name.
static java.lang.String NAME_VIEWPROPS
          Deprecated. This constant specifies the View Properties access name.
protected  int objType
          Deprecated. Type of object.
protected static int PROMOTE_VERSION
          Deprecated. This constant defines the Document Publish Access Level mask.
protected static int PUBLISH
          Deprecated. This constant defines the Document Publish Access Level mask.
static int REVOKE
          Deprecated. This constant indicates a revoke state.
protected static int SEARCH_MODIFY_CONTENT
          Deprecated. This constant defines the Search/Publish Template Modify Content Access Level mask.
protected static int SEARCH_MODIFY_PROPERTIES
          Deprecated. This constant defines the Search/Publish Template Modify Properties Access Level mask.
protected static int SEARCH_OWNER_CONTROL
          Deprecated. This constant defines the Search/Publish Template Owner Control Access Level mask.
static int SECURITY_POLICY_DENY
          Deprecated. This constant indicates a deny state through security policy.
static int SECURITY_POLICY_GRANT
          Deprecated. This constant indicates a grant state through security policy.
protected  int securityPolicyAllow
          Deprecated. Bit field indicating security policy access allow rights.
protected  int securityPolicyDeny
          Deprecated. Bit field indicating security policy access deny rights.
protected static int VIEW_CONTENT
          Deprecated. This constant defines the View Content Access Level mask.
protected static int VIEW_PROPERTIES
          Deprecated. This constant defines the View Properties Access Level mask.
 
Constructor Summary
WcmSecurityAccessUtil()
          Deprecated.  
 
Method Summary
protected  int computeAccessRight(int accessLevel)
          Deprecated. Compute and return a simplified access right for the specified access level mask.
static int computeAccessRight(int allowBits, int denyBits, int securityPolicyAllowBits, int securityPolicyDenyBits, int inheritedAllowBits, int inheritedDenyBits, int accessLevel, int objectType)
          Deprecated. Compute and return a simplified access right set by the specified allow bits, deny bits, inherited deny bits and inherited allow bits for a given access level mask.
 void denyAccess(int accessLevel)
          Deprecated. Explicitly deny the selected grantee the specified access level by setting the deny bit field.
 int getDefaultAllowMask()
          Deprecated. Get the default allow access rights for a new grantee.
 int getDefaultDenyMask()
          Deprecated. Get the default deny access rights for a new grantee.
static java.lang.String getSystemNotes(int accessRights)
          Deprecated. Return the system note of the specified access right status.
 void grantAccess(int accessLevel)
          Deprecated. Explicitly grant the selected grantee the specified access level by setting the allow bit field.
static java.lang.String mapAccessLevelToName(int accessLevel)
          Deprecated. Get the localized access name of the given access level mask.
 void revokeAccess(int accessLevel, int accessType)
          Deprecated. Revoke the explicit allow or the explicit deny access settings.
protected  void setAccessLevels(int objType)
          Deprecated. Set access levels for an object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME_OWNERCTRL

public static final java.lang.String NAME_OWNERCTRL
Deprecated. 
This constant specifies the Owner Control access name.


NAME_MODIFYCONTENT

public static final java.lang.String NAME_MODIFYCONTENT
Deprecated. 
This constant specifies the Modify Content access name.


NAME_MODIFYPROPS

public static final java.lang.String NAME_MODIFYPROPS
Deprecated. 
This constant specifies the Modify Properties access name.


NAME_VIEWCONTENT

public static final java.lang.String NAME_VIEWCONTENT
Deprecated. 
This constant specifies the View Content access name.


NAME_VIEWPROPS

public static final java.lang.String NAME_VIEWPROPS
Deprecated. 
This constant specifies the View Properties access name.


NAME_ADDTOFOLDER

public static final java.lang.String NAME_ADDTOFOLDER
Deprecated. 
This constant specifies the Add To Folder access name.


NAME_PROMOTEVERSION

public static final java.lang.String NAME_PROMOTEVERSION
Deprecated. 
This constant specifies the Promote Version access name.


NAME_PUBLISH

public static final java.lang.String NAME_PUBLISH
Deprecated. 
This constant specifies the Publish access name.


REVOKE

public static final int REVOKE
Deprecated. 
This constant indicates a revoke state.

See Also:
Constant Field Values

GRANT

public static final int GRANT
Deprecated. 
This constant indicates a grant state.

See Also:
Constant Field Values

SECURITY_POLICY_GRANT

public static final int SECURITY_POLICY_GRANT
Deprecated. 
This constant indicates a grant state through security policy.

See Also:
Constant Field Values

INHERITED_GRANT

public static final int INHERITED_GRANT
Deprecated. 
This constant indicates a grant state through inheritance.

See Also:
Constant Field Values

DENY

public static final int DENY
Deprecated. 
This constant indicates a deny state.

See Also:
Constant Field Values

SECURITY_POLICY_DENY

public static final int SECURITY_POLICY_DENY
Deprecated. 
This constant indicates a deny state through security policy.

See Also:
Constant Field Values

INHERITED_DENY

public static final int INHERITED_DENY
Deprecated. 
This constant indicates a deny state through inheritance.

See Also:
Constant Field Values

ADVANCE_SETTINGS

public static final int ADVANCE_SETTINGS
Deprecated. 
This constant indicates an Advanced System Defined Settings state.

See Also:
Constant Field Values

VIEW_PROPERTIES

protected static final int VIEW_PROPERTIES
Deprecated. 
This constant defines the View Properties Access Level mask.

See Also:
Constant Field Values

VIEW_CONTENT

protected static final int VIEW_CONTENT
Deprecated. 
This constant defines the View Content Access Level mask.

See Also:
Constant Field Values

ADD_TO_FOLDER

protected static final int ADD_TO_FOLDER
Deprecated. 
This constant defines the Add To Folder Access Level mask.

See Also:
Constant Field Values

FOLDER_MODIFY_PROPERTIES

protected static final int FOLDER_MODIFY_PROPERTIES
Deprecated. 
This constant defines the Folder Modify Properties Access Level mask.

See Also:
Constant Field Values

CUSTOMOBJECT_MODIFY_PROPERTIES

protected static final int CUSTOMOBJECT_MODIFY_PROPERTIES
Deprecated. 
This constant defines the Custom Object Modify Properties Access Level mask.

See Also:
Constant Field Values

DEFAULT_MODIFY_PROPERTIES

protected static final int DEFAULT_MODIFY_PROPERTIES
Deprecated. 
This constant defines the default Modify Properties Access Level mask.

See Also:
Constant Field Values

DOCUMENT_MODIFY_PROPERTIES

protected static final int DOCUMENT_MODIFY_PROPERTIES
Deprecated. 
This constant defines the Document Modify Properties Access Level mask.

See Also:
Constant Field Values

SEARCH_MODIFY_PROPERTIES

protected static final int SEARCH_MODIFY_PROPERTIES
Deprecated. 
This constant defines the Search/Publish Template Modify Properties Access Level mask.

See Also:
Constant Field Values

DOCUMENT_MODIFY_CONTENT

protected static final int DOCUMENT_MODIFY_CONTENT
Deprecated. 
This constant defines the Document Modify Content Access Level mask.

See Also:
Constant Field Values

SEARCH_MODIFY_CONTENT

protected static final int SEARCH_MODIFY_CONTENT
Deprecated. 
This constant defines the Search/Publish Template Modify Content Access Level mask.

See Also:
Constant Field Values

FOLDER_OWNER_CONTROL

protected static final int FOLDER_OWNER_CONTROL
Deprecated. 
This constant defines the Folder Owner Control Access Level mask.

See Also:
Constant Field Values

CUSTOMOBJECT_OWNER_CONTROL

protected static final int CUSTOMOBJECT_OWNER_CONTROL
Deprecated. 
This constant defines the Custom Object Owner Control Access Level mask.

See Also:
Constant Field Values

DEFAULT_OWNER_CONTROL

protected static final int DEFAULT_OWNER_CONTROL
Deprecated. 
This constant defines the default Owner Control Access Level mask.

See Also:
Constant Field Values

DOCUMENT_OWNER_CONTROL

protected static final int DOCUMENT_OWNER_CONTROL
Deprecated. 
This constant defines the Document Owner Control Access Level mask.

See Also:
Constant Field Values

SEARCH_OWNER_CONTROL

protected static final int SEARCH_OWNER_CONTROL
Deprecated. 
This constant defines the Search/Publish Template Owner Control Access Level mask.

See Also:
Constant Field Values

PROMOTE_VERSION

protected static final int PROMOTE_VERSION
Deprecated. 
This constant defines the Document Publish Access Level mask.

See Also:
Constant Field Values

PUBLISH

protected static final int PUBLISH
Deprecated. 
This constant defines the Document Publish Access Level mask.

See Also:
Constant Field Values

DEFAULT_DOCUMENT_ALLOW_ACCESS

protected static final int DEFAULT_DOCUMENT_ALLOW_ACCESS
Deprecated. 
This constant defines the document object default access right of a new grantee.

See Also:
Constant Field Values

DEFAULT_FOLDER_ALLOW_ACCESS

protected static final int DEFAULT_FOLDER_ALLOW_ACCESS
Deprecated. 
This constant defines the folder object default access right of a new grantee.

See Also:
Constant Field Values

DEFAULT_SEARCH_ALLOW_ACCESS

protected static final int DEFAULT_SEARCH_ALLOW_ACCESS
Deprecated. 
This constant defines the search/publish template object default access right of a new grantee.

See Also:
Constant Field Values

DEFAULT_CUSTOMOBJECT_ALLOW_ACCESS

protected static final int DEFAULT_CUSTOMOBJECT_ALLOW_ACCESS
Deprecated. 
This constant defines the custom object object default access right of a new grantee.

See Also:
Constant Field Values

DEFAULT_WORKFLOW_SUBSCRIPTION_ALLOW_ACCESS

protected static final int DEFAULT_WORKFLOW_SUBSCRIPTION_ALLOW_ACCESS
Deprecated. 
This constant defines the workflow subscription object default access right of a new grantee.

See Also:
Constant Field Values

accessLevels

protected int[] accessLevels
Deprecated. 
Hold the security access levels.


allow

protected int allow
Deprecated. 
Bit field indicating access allow rights.


deny

protected int deny
Deprecated. 
Bit field indicating access deny rights.


securityPolicyAllow

protected int securityPolicyAllow
Deprecated. 
Bit field indicating security policy access allow rights.


securityPolicyDeny

protected int securityPolicyDeny
Deprecated. 
Bit field indicating security policy access deny rights.


inheritedAllow

protected int inheritedAllow
Deprecated. 
Bit field indicating inherited access allow rights.


inheritedDeny

protected int inheritedDeny
Deprecated. 
Bit field indicating inherited access deny rights.


objType

protected int objType
Deprecated. 
Type of object.

See Also:
com.filenet.wcm.api.BaseObject##TYPE_DOCUMENT, com.filenet.wcm.api.BaseObject##TYPE_FOLDER, com.filenet.wcm.api.BaseObject##TYPE_STORED_SEARCH, com.filenet.wcm.api.BaseObject##TYPE_PUBLISH_TEMPLATE
Constructor Detail

WcmSecurityAccessUtil

public WcmSecurityAccessUtil()
Deprecated. 
Method Detail

getDefaultAllowMask

public int getDefaultAllowMask()
                        throws java.lang.Exception
Deprecated. 
Get the default allow access rights for a new grantee.

Returns:
The default allow access bit field for a new grantee.
Throws:
java.lang.Exception - All Errors.

getDefaultDenyMask

public int getDefaultDenyMask()
                       throws java.lang.Exception
Deprecated. 
Get the default deny access rights for a new grantee.

Returns:
The default deny access bit field for a new grantee.
Throws:
java.lang.Exception - All Errors.

mapAccessLevelToName

public static java.lang.String mapAccessLevelToName(int accessLevel)
                                             throws java.lang.Exception
Deprecated. 
Get the localized access name of the given access level mask.

Parameters:
accessLevel - The access level bit field.
Returns:
The name of access level.
Throws:
java.lang.Exception - All Errors.

See Also:
setAccessLevels

computeAccessRight

public static int computeAccessRight(int allowBits,
                                     int denyBits,
                                     int securityPolicyAllowBits,
                                     int securityPolicyDenyBits,
                                     int inheritedAllowBits,
                                     int inheritedDenyBits,
                                     int accessLevel,
                                     int objectType)
                              throws java.lang.Exception
Deprecated. 
Compute and return a simplified access right set by the specified allow bits, deny bits, inherited deny bits and inherited allow bits for a given access level mask.

This method uses the allow, deny, inherited allow, and inherited deny bit fields for computing the access right.

The simplified values of the Security Access are:

      0=Implicit Deny
      1=Allow
      2=Allow due to security policy
      3=Inherited Allow
      4=Deny
      5=Deny due to security policy
      6=Inherited Deny
      7=Advanced System Defined Settings
 

Parameters:
allowBits - The allow bit field.
denyBits - The deny bit field.
securityPolicyAllowBits - The security policy allow bit field.
securityPolicyDenyBits - The security policy deny bit field.
inheritedAllowBits - The inherited allow bit field.
inheritedDenyBits - The inherited deny bit field.
accessLevel - The access level bit field.
Returns:
A simplified access right status.
Throws:
java.lang.Exception - All Errors.

getSystemNotes

public static java.lang.String getSystemNotes(int accessRights)
Deprecated. 
Return the system note of the specified access right status. The system note is used to further explain the current security settings defined by the system.

Parameters:
accessRights - The access right status:
      0=Implicit Deny
      1=Allow
      2=Allow due to security policy
      3=Inherited Allow
      4=Deny
      5=Deny due to security policy
      6=Inherited Deny
      7=Advanced System Defined Settings
 
Returns:
The system note associates with the specified access right status.

grantAccess

public final void grantAccess(int accessLevel)
                       throws java.lang.Exception
Deprecated. 
Explicitly grant the selected grantee the specified access level by setting the allow bit field.

Parameters:
accessLevel - The access level bit field.
Throws:
java.lang.Exception - All Errors.

denyAccess

public final void denyAccess(int accessLevel)
                      throws java.lang.Exception
Deprecated. 
Explicitly deny the selected grantee the specified access level by setting the deny bit field.

Parameters:
accessLevel - The access level bit field.
Throws:
java.lang.Exception - All Errors.

revokeAccess

public void revokeAccess(int accessLevel,
                         int accessType)
                  throws java.lang.Exception
Deprecated. 
Revoke the explicit allow or the explicit deny access settings.

Parameters:
accessLevel - The access level bit field.
accessType - The access type (allow or deny type)
Throws:
java.lang.Exception - All Errors.
See Also:
com.filenet.wcm.api.Permission##TYPE_ALLOW., com.filenet.wcm.api.Permission##TYPE_DENY.

setAccessLevels

protected void setAccessLevels(int objType)
                        throws java.lang.Exception
Deprecated. 
Set access levels for an object. This method must be called before calling other methods in this class.

Parameters:
objType - The object type.
Throws:
java.lang.Exception - All Errors.
See Also:
com.filenet.wcm.api.BaseObject##TYPE_DOCUMENT, com.filenet.wcm.api.BaseObject##TYPE_FOLDER, com.filenet.wcm.api.BaseObject##TYPE_STORED_SEARCH, com.filenet.wcm.api.BaseObject##TYPE_PUBLISH_TEMPLATE

computeAccessRight

protected int computeAccessRight(int accessLevel)
                          throws java.lang.Exception
Deprecated. 
Compute and return a simplified access right for the specified access level mask.

This method uses the allow, deny, inherited allow, and inherited deny bit fields for computing the access right.

The simplified values of the Security Access are: 0=Implicit Deny, 1=Allow, 2=Inherited Allow, 3=Deny, 4=Inherited Deny, 5=Advanced System Defined Settings.

Parameters:
accessLevel - The access level bit field.
Returns:
A simplified access right status.
Throws:
java.lang.Exception - All Errors.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.