Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.slide.common
Class NamespaceConfig  view NamespaceConfig download NamespaceConfig.java

java.lang.Object
  extended byorg.apache.slide.common.NamespaceConfig

public final class NamespaceConfig
extends java.lang.Object

Configuration of the Namespace.

Version:
$Revision: 1.36 $

Field Summary
private static java.lang.String ACL_INHERIT_TYPE
           
static int ACL_INHERIT_TYPE_FULL
           
static int ACL_INHERIT_TYPE_NONE
           
static int ACL_INHERIT_TYPE_PATH
           
static int ACL_INHERIT_TYPE_ROOT
           
static java.lang.String ACTION_ROLE
           
protected  java.lang.String actionsPath
          File path.
protected  boolean autoCreateUsers
          Automatically create users.
protected  java.lang.String autoCreateUsersRole
          Roles implementation to be used for automatically created users.
static java.lang.String BASE_ROLE
           
protected  org.apache.slide.structure.ActionNode bindMemberAction
          Bind/unbind actions
protected  org.apache.slide.content.ContentInterceptor[] contentInterceptors
          Content interceptors.
protected  org.apache.slide.structure.ActionNode createObjectAction
          Create object action.
protected  org.apache.slide.structure.ActionNode createRevisionContentAction
          Create revision content action.
protected  org.apache.slide.structure.ActionNode createRevisionMetadataAction
          Create revision metadata action.
protected  java.util.Hashtable defaultProperties
          List of default properties.
protected static java.util.Vector emptyVector
          Empty vector.
protected  java.lang.String filesPath
          File path.
protected  org.apache.slide.structure.ActionNode grantPermissionAction
          Grant permission action.
protected  java.lang.String groupsPath
           
private  UriPath groupsUriPath
           
protected  java.lang.String guestPath
          Guest user path.
protected  org.apache.slide.structure.ActionNode killLockAction
          Kill lock action.
static java.lang.String LINK_ROLE
           
protected  org.apache.slide.structure.ActionNode lockObjectAction
          Lock object action.
protected  org.apache.slide.structure.ActionNode modifyRevisionContentAction
          Modify revision content action.
protected  org.apache.slide.structure.ActionNode modifyRevisionMetadataAction
          Modify revision metadata action.
protected  java.lang.String name
          Namespace name.
private static java.lang.String NESTED_ROLES_MAXDEPTH
           
private static int NESTED_ROLES_MAXDEPTH_DEFAULT
           
static java.lang.String NOBODY
          Base role names.
static java.lang.String NOBODY_ROLE
           
protected  java.util.Hashtable parameters
          Additional parameters.
protected  org.apache.slide.structure.ActionNode readLocksAction
          Read locks action.
protected  org.apache.slide.structure.ActionNode readObjectAction
          Read object action.
protected  org.apache.slide.structure.ActionNode readOwnPermissionsAction
           
protected  org.apache.slide.structure.ActionNode readPermissionsAction
          Read permissions action.
protected  org.apache.slide.structure.ActionNode readRevisionContentAction
          Read revision content action.
protected  org.apache.slide.structure.ActionNode readRevisionMetadataAction
          Read revision metadata action.
protected  org.apache.slide.structure.ActionNode removeObjectAction
          Remove object action.
protected  org.apache.slide.structure.ActionNode removeRevisionContentAction
          Remove revision content action.
protected  org.apache.slide.structure.ActionNode removeRevisionMetadataAction
          Remove revision metadata action.
protected  org.apache.slide.structure.ActionNode revokePermissionAction
          Revoke permission action.
protected  java.util.Hashtable roleClassMappings
          Role interface -> role name mappings.
protected  java.util.Hashtable roleMappings
          Role name -> role interface mappings.
protected  java.lang.String rolesPath
           
private  UriPath rolesUriPath
           
protected  org.apache.slide.structure.ActionNode unbindMemberAction
           
protected  java.lang.String usersPath
          Users path.
private  UriPath usersUriPath
           
 
Constructor Summary
NamespaceConfig()
           
 
Method Summary
protected  void addDefaultProperty(java.lang.String role, java.lang.String name, java.lang.String value, java.lang.String namespace)
          Add a new default property.
protected  void addParameter(java.lang.String name, java.lang.String value)
          Add a new parameter.
protected  void addRoleMapping(java.lang.String name, java.lang.String value)
          Add a new role mapping.
 int getAclInheritanceType()
           
protected  org.apache.slide.structure.ActionNode getActionNode(Namespace namespace, java.lang.String actionPath)
          Retrieve an action node.
 java.lang.String getActionsPath()
          Actions path accessor.
 java.lang.String getAutoCreateUsersRole()
          Get the class name of the role which will be used to create nodes which are automatically created when isAutoCreateUsers() returns true.
 org.apache.slide.structure.ActionNode getBindMemberAction()
          Method getBindAction
private  org.apache.slide.structure.ActionNode getConfiguredNode(Namespace namespace, org.apache.slide.util.conf.Configuration config, java.lang.String nodeName)
           
(package private)  org.apache.slide.content.ContentInterceptor[] getContentInterceptors()
          Get content interceptors.
 org.apache.slide.structure.ActionNode getCreateObjectAction()
          Create object action accessor.
 org.apache.slide.structure.ActionNode getCreateRevisionContentAction()
          Create revision content accessor.
 org.apache.slide.structure.ActionNode getCreateRevisionMetadataAction()
          Create revision metadata accessor.
 org.apache.slide.structure.ActionNode getDefaultAction()
          Default action accessor.
 java.util.Enumeration getDefaultProperties(java.lang.String role)
          Get default properties for a given role.
 java.lang.String getFilesPath()
          Files path accessor.
 org.apache.slide.structure.ActionNode getGrantPermissionAction()
          Grant permission accessor.
 java.lang.String getGroupsPath()
          Groups path accessor.
 java.lang.String getGuestPath()
          Deprecated. There is now a generic SubjectNode for "guest"
 org.apache.slide.structure.ActionNode getKillLockAction()
          Kill lock accessor.
 org.apache.slide.structure.ActionNode getLockObjectAction()
          Lock object accessor.
 org.apache.slide.structure.ActionNode getModifyRevisionContentAction()
          Modify revision content accessor.
 org.apache.slide.structure.ActionNode getModifyRevisionMetadataAction()
          Modify revision metadata accessor.
 int getNestedRolesMaxDepth()
           
 java.lang.String getParameter(java.lang.String name)
          Get parameter value.
 org.apache.slide.structure.ActionNode getReadLocksAction()
          Read locks accessor.
 org.apache.slide.structure.ActionNode getReadObjectAction()
          Read object action accessor.
 org.apache.slide.structure.ActionNode getReadOwnPermissionsAction()
           
 org.apache.slide.structure.ActionNode getReadPermissionsAction()
          Read permissions accessor.
 org.apache.slide.structure.ActionNode getReadRevisionContentAction()
          Read revision content accessor.
 org.apache.slide.structure.ActionNode getReadRevisionMetadataAction()
          Read revision metadata accessor.
 org.apache.slide.structure.ActionNode getRemoveObjectAction()
          Remove object accessor.
 org.apache.slide.structure.ActionNode getRemoveRevisionContentAction()
          Remove revision content accessor.
 org.apache.slide.structure.ActionNode getRemoveRevisionMetadataAction()
          Remove revision metadata accessor.
 org.apache.slide.structure.ActionNode getRevokePermissionAction()
          Revoke permission accessor.
 java.lang.String getRoleMapping(java.lang.String name)
          Get role mapping.
 java.lang.String getRolesPath()
          Roles path accessor.
 org.apache.slide.structure.ActionNode getUnbindMemberAction()
           
 java.lang.String getUsersPath()
          Users path accessor.
(package private)  void initializeAsDummyConfig(Namespace namespace)
          Create a dummy config, used to create the base namespace data.
 void initializeForTestPurposesOnly()
          TEST PURPOSES ONLY.
(package private)  void initializeNamespaceConfig(Namespace namespace, org.apache.slide.util.conf.Configuration config)
          Initialize the Namespace configuration using the given Configuration object.
(package private)  void initializeNamespaceParameters(Namespace namespace, org.apache.slide.util.conf.Configuration config)
          Initialize the Namespace configuration using the given Configuration object.
 boolean isAutoCreateUsers()
          Is automcatic user creation active ?
 boolean isGroup(java.lang.String uri)
           
 boolean isPrincipal(java.lang.String uri)
           
 boolean isRole(java.lang.String uri)
           
private  void setDefaultProperties(org.apache.slide.util.conf.Configuration config, Namespace namespace)
           
private  void setParameters(org.apache.slide.util.conf.Configuration config, Namespace namespace)
           
private  void setPathsAndConfigValues(org.apache.slide.util.conf.Configuration config)
           
private  void setRoles(org.apache.slide.util.conf.Configuration config, Namespace namespace)
           
 java.lang.String toString()
          Get a String representation of this domain.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOBODY

public static final java.lang.String NOBODY
Base role names.

See Also:
Constant Field Values

NOBODY_ROLE

public static final java.lang.String NOBODY_ROLE

BASE_ROLE

public static final java.lang.String BASE_ROLE

ACTION_ROLE

public static final java.lang.String ACTION_ROLE

LINK_ROLE

public static final java.lang.String LINK_ROLE

ACL_INHERIT_TYPE

private static final java.lang.String ACL_INHERIT_TYPE
See Also:
Constant Field Values

NESTED_ROLES_MAXDEPTH

private static final java.lang.String NESTED_ROLES_MAXDEPTH
See Also:
Constant Field Values

NESTED_ROLES_MAXDEPTH_DEFAULT

private static final int NESTED_ROLES_MAXDEPTH_DEFAULT
See Also:
Constant Field Values

ACL_INHERIT_TYPE_NONE

public static final int ACL_INHERIT_TYPE_NONE
See Also:
Constant Field Values

ACL_INHERIT_TYPE_ROOT

public static final int ACL_INHERIT_TYPE_ROOT
See Also:
Constant Field Values

ACL_INHERIT_TYPE_PATH

public static final int ACL_INHERIT_TYPE_PATH
See Also:
Constant Field Values

ACL_INHERIT_TYPE_FULL

public static final int ACL_INHERIT_TYPE_FULL
See Also:
Constant Field Values

name

protected java.lang.String name
Namespace name.


readObjectAction

protected org.apache.slide.structure.ActionNode readObjectAction
Read object action.


createObjectAction

protected org.apache.slide.structure.ActionNode createObjectAction
Create object action. Equivalent to createChildAction.


removeObjectAction

protected org.apache.slide.structure.ActionNode removeObjectAction
Remove object action.


grantPermissionAction

protected org.apache.slide.structure.ActionNode grantPermissionAction
Grant permission action.


revokePermissionAction

protected org.apache.slide.structure.ActionNode revokePermissionAction
Revoke permission action.


readPermissionsAction

protected org.apache.slide.structure.ActionNode readPermissionsAction
Read permissions action.


readOwnPermissionsAction

protected org.apache.slide.structure.ActionNode readOwnPermissionsAction

lockObjectAction

protected org.apache.slide.structure.ActionNode lockObjectAction
Lock object action.


killLockAction

protected org.apache.slide.structure.ActionNode killLockAction
Kill lock action.


readLocksAction

protected org.apache.slide.structure.ActionNode readLocksAction
Read locks action.


createRevisionMetadataAction

protected org.apache.slide.structure.ActionNode createRevisionMetadataAction
Create revision metadata action.


modifyRevisionMetadataAction

protected org.apache.slide.structure.ActionNode modifyRevisionMetadataAction
Modify revision metadata action.


removeRevisionMetadataAction

protected org.apache.slide.structure.ActionNode removeRevisionMetadataAction
Remove revision metadata action.


readRevisionMetadataAction

protected org.apache.slide.structure.ActionNode readRevisionMetadataAction
Read revision metadata action.


readRevisionContentAction

protected org.apache.slide.structure.ActionNode readRevisionContentAction
Read revision content action.


createRevisionContentAction

protected org.apache.slide.structure.ActionNode createRevisionContentAction
Create revision content action.


modifyRevisionContentAction

protected org.apache.slide.structure.ActionNode modifyRevisionContentAction
Modify revision content action.


removeRevisionContentAction

protected org.apache.slide.structure.ActionNode removeRevisionContentAction
Remove revision content action.


bindMemberAction

protected org.apache.slide.structure.ActionNode bindMemberAction
Bind/unbind actions


unbindMemberAction

protected org.apache.slide.structure.ActionNode unbindMemberAction

usersPath

protected java.lang.String usersPath
Users path.


groupsPath

protected java.lang.String groupsPath

rolesPath

protected java.lang.String rolesPath

usersUriPath

private UriPath usersUriPath

groupsUriPath

private UriPath groupsUriPath

rolesUriPath

private UriPath rolesUriPath

guestPath

protected java.lang.String guestPath
Guest user path.


filesPath

protected java.lang.String filesPath
File path.


actionsPath

protected java.lang.String actionsPath
File path.


parameters

protected java.util.Hashtable parameters
Additional parameters.


roleMappings

protected java.util.Hashtable roleMappings
Role name -> role interface mappings. Note : One name is associated to only one interface.


roleClassMappings

protected java.util.Hashtable roleClassMappings
Role interface -> role name mappings. Note : One interface can be associated to multiple names, in which case only one is stored here.


defaultProperties

protected java.util.Hashtable defaultProperties
List of default properties. Role name -> Vector[NodeProperty].


emptyVector

protected static java.util.Vector emptyVector
Empty vector. Don't add stuff there.


contentInterceptors

protected org.apache.slide.content.ContentInterceptor[] contentInterceptors
Content interceptors.


autoCreateUsers

protected boolean autoCreateUsers
Automatically create users.


autoCreateUsersRole

protected java.lang.String autoCreateUsersRole
Roles implementation to be used for automatically created users.

Constructor Detail

NamespaceConfig

public NamespaceConfig()
Method Detail

getDefaultAction

public org.apache.slide.structure.ActionNode getDefaultAction()
Default action accessor.


getReadObjectAction

public org.apache.slide.structure.ActionNode getReadObjectAction()
Read object action accessor.


getCreateObjectAction

public org.apache.slide.structure.ActionNode getCreateObjectAction()
Create object action accessor.


getRemoveObjectAction

public org.apache.slide.structure.ActionNode getRemoveObjectAction()
Remove object accessor.


getGrantPermissionAction

public org.apache.slide.structure.ActionNode getGrantPermissionAction()
Grant permission accessor.


getRevokePermissionAction

public org.apache.slide.structure.ActionNode getRevokePermissionAction()
Revoke permission accessor.


getReadPermissionsAction

public org.apache.slide.structure.ActionNode getReadPermissionsAction()
Read permissions accessor.


getReadOwnPermissionsAction

public org.apache.slide.structure.ActionNode getReadOwnPermissionsAction()

getLockObjectAction

public org.apache.slide.structure.ActionNode getLockObjectAction()
Lock object accessor.


getKillLockAction

public org.apache.slide.structure.ActionNode getKillLockAction()
Kill lock accessor.


getReadLocksAction

public org.apache.slide.structure.ActionNode getReadLocksAction()
Read locks accessor.


getCreateRevisionMetadataAction

public org.apache.slide.structure.ActionNode getCreateRevisionMetadataAction()
Create revision metadata accessor.


getReadRevisionMetadataAction

public org.apache.slide.structure.ActionNode getReadRevisionMetadataAction()
Read revision metadata accessor.


getModifyRevisionMetadataAction

public org.apache.slide.structure.ActionNode getModifyRevisionMetadataAction()
Modify revision metadata accessor.


getRemoveRevisionMetadataAction

public org.apache.slide.structure.ActionNode getRemoveRevisionMetadataAction()
Remove revision metadata accessor.


getReadRevisionContentAction

public org.apache.slide.structure.ActionNode getReadRevisionContentAction()
Read revision content accessor.


getCreateRevisionContentAction

public org.apache.slide.structure.ActionNode getCreateRevisionContentAction()
Create revision content accessor.


getModifyRevisionContentAction

public org.apache.slide.structure.ActionNode getModifyRevisionContentAction()
Modify revision content accessor.


getRemoveRevisionContentAction

public org.apache.slide.structure.ActionNode getRemoveRevisionContentAction()
Remove revision content accessor.


getBindMemberAction

public org.apache.slide.structure.ActionNode getBindMemberAction()
Method getBindAction


getUnbindMemberAction

public org.apache.slide.structure.ActionNode getUnbindMemberAction()

getUsersPath

public java.lang.String getUsersPath()
Users path accessor.


getGroupsPath

public java.lang.String getGroupsPath()
Groups path accessor.


getRolesPath

public java.lang.String getRolesPath()
Roles path accessor.


getGuestPath

public java.lang.String getGuestPath()
Deprecated. There is now a generic SubjectNode for "guest"

Guest path accessor.


getFilesPath

public java.lang.String getFilesPath()
Files path accessor.


getActionsPath

public java.lang.String getActionsPath()
Actions path accessor.


getDefaultProperties

public java.util.Enumeration getDefaultProperties(java.lang.String role)
Get default properties for a given role.


getContentInterceptors

org.apache.slide.content.ContentInterceptor[] getContentInterceptors()
Get content interceptors.


getParameter

public java.lang.String getParameter(java.lang.String name)
Get parameter value.


getRoleMapping

public java.lang.String getRoleMapping(java.lang.String name)
Get role mapping. If the interface name is given, one of the names is returned. If the name is given, the interface name is returned.


isAutoCreateUsers

public boolean isAutoCreateUsers()
Is automcatic user creation active ?


isPrincipal

public boolean isPrincipal(java.lang.String uri)

isRole

public boolean isRole(java.lang.String uri)

isGroup

public boolean isGroup(java.lang.String uri)

getAutoCreateUsersRole

public java.lang.String getAutoCreateUsersRole()
Get the class name of the role which will be used to create nodes which are automatically created when isAutoCreateUsers() returns true.


getAclInheritanceType

public int getAclInheritanceType()

getNestedRolesMaxDepth

public int getNestedRolesMaxDepth()

initializeNamespaceConfig

void initializeNamespaceConfig(Namespace namespace,
                               org.apache.slide.util.conf.Configuration config)
                         throws InvalidNamespaceConfigurationException,
                                SlideException
Initialize the Namespace configuration using the given Configuration object.


setDefaultProperties

private void setDefaultProperties(org.apache.slide.util.conf.Configuration config,
                                  Namespace namespace)
                           throws InvalidNamespaceConfigurationException

setParameters

private void setParameters(org.apache.slide.util.conf.Configuration config,
                           Namespace namespace)
                    throws InvalidNamespaceConfigurationException

getConfiguredNode

private org.apache.slide.structure.ActionNode getConfiguredNode(Namespace namespace,
                                                                org.apache.slide.util.conf.Configuration config,
                                                                java.lang.String nodeName)
                                                         throws SlideException

setPathsAndConfigValues

private void setPathsAndConfigValues(org.apache.slide.util.conf.Configuration config)

initializeNamespaceParameters

void initializeNamespaceParameters(Namespace namespace,
                                   org.apache.slide.util.conf.Configuration config)
                             throws InvalidNamespaceConfigurationException,
                                    SlideException
Initialize the Namespace configuration using the given Configuration object.


setRoles

private void setRoles(org.apache.slide.util.conf.Configuration config,
                      Namespace namespace)
               throws InvalidNamespaceConfigurationException

initializeAsDummyConfig

void initializeAsDummyConfig(Namespace namespace)
                       throws InvalidNamespaceConfigurationException
Create a dummy config, used to create the base namespace data.


initializeForTestPurposesOnly

public void initializeForTestPurposesOnly()
                                   throws InvalidNamespaceConfigurationException
TEST PURPOSES ONLY.


addParameter

protected void addParameter(java.lang.String name,
                            java.lang.String value)
Add a new parameter.


addDefaultProperty

protected void addDefaultProperty(java.lang.String role,
                                  java.lang.String name,
                                  java.lang.String value,
                                  java.lang.String namespace)
Add a new default property.


addRoleMapping

protected void addRoleMapping(java.lang.String name,
                              java.lang.String value)
Add a new role mapping.


getActionNode

protected org.apache.slide.structure.ActionNode getActionNode(Namespace namespace,
                                                              java.lang.String actionPath)
                                                       throws InvalidNamespaceConfigurationException,
                                                              SlideException
Retrieve an action node.


toString

public java.lang.String toString()
Get a String representation of this domain.