|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.lenya.cms.cocoon.components.modules.input.AccessControlModule
public class AccessControlModule
Input module for access control attributes.
Attributes:
user-id
- the ID of the currently logged-in useruser-name
- the full name of the currently logged-in useruser-name:{user-id}
- the full name of a specific useruser-email
- the e-mail address of the currently logged-in useruser-email:{user-id}
- the e-mail address of a specific userip-address
- the IP address of the client machinerole-ids
- the role IDs which are granted to the current identityuser-manager
- the user manager objectgroup-manager
- the group manager objectiprange-manager
- the IP range manager objectrole-manager
- the role manager object
Field Summary | |
---|---|
static java.lang.String |
GROUP_MANAGER
GROUP_MANAGER The group manager |
static java.lang.String |
IP_ADDRESS
IP_ADDRESS The IP address |
static java.lang.String |
IP_RANGE_MANAGER
IP_RANGE_MANAGER The IP range manager |
static java.lang.String |
ROLE_IDS
ROLE_IDS The role ids |
static java.lang.String |
ROLE_MANAGER
ROLE_MANAGER The role manager |
static java.lang.String |
SSL
Returns if the current page is SSL protected (true|false). |
static java.lang.String |
USER_EMAIL
USER_EMAIL The user email, optional: provide the user ID after a colon |
static java.lang.String |
USER_ID
USER_ID The user id |
static java.lang.String |
USER_MANAGER
USER_MANAGER The user manager |
static java.lang.String |
USER_NAME
USER_NAME The user name, optional: provide the user ID after a colon |
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule |
---|
settings |
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule |
---|
ROLE |
Constructor Summary | |
---|---|
AccessControlModule()
|
Method Summary | |
---|---|
java.lang.Object |
getAttribute(java.lang.String attribute,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
|
java.util.Iterator |
getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
|
java.lang.Object[] |
getAttributeValues(java.lang.String name,
org.apache.avalon.framework.configuration.Configuration modeConf,
java.util.Map objectModel)
|
protected org.apache.lenya.ac.ItemManager |
getItemManager(org.apache.cocoon.environment.Request request,
java.lang.String name)
Returns the item manager for a certain name. |
protected org.apache.lenya.ac.User |
getUser(org.apache.cocoon.environment.Request request,
java.lang.String[] parameters,
org.apache.lenya.ac.Identity identity)
Returns the user specified with parameter[1], falling back to the currently logged in user. |
void |
service(org.apache.avalon.framework.service.ServiceManager _manager)
|
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule |
---|
configure, dispose |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
---|
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String USER_ID
USER_ID
The user id
public static final java.lang.String USER_NAME
USER_NAME
The user name, optional: provide the user ID after a colon
public static final java.lang.String USER_EMAIL
USER_EMAIL
The user email, optional: provide the user ID after a colon
public static final java.lang.String IP_ADDRESS
IP_ADDRESS
The IP address
public static final java.lang.String ROLE_IDS
ROLE_IDS
The role ids
public static final java.lang.String USER_MANAGER
USER_MANAGER
The user manager
public static final java.lang.String GROUP_MANAGER
GROUP_MANAGER
The group manager
public static final java.lang.String ROLE_MANAGER
ROLE_MANAGER
The role manager
public static final java.lang.String IP_RANGE_MANAGER
IP_RANGE_MANAGER
The IP range manager
public static final java.lang.String SSL
Constructor Detail |
---|
public AccessControlModule()
Method Detail |
---|
public java.lang.Object getAttribute(java.lang.String attribute, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) throws org.apache.avalon.framework.configuration.ConfigurationException
getAttribute
in interface org.apache.cocoon.components.modules.input.InputModule
getAttribute
in class org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.avalon.framework.configuration.ConfigurationException
InputModule.getAttribute(java.lang.String,
org.apache.avalon.framework.configuration.Configuration, java.util.Map)
protected org.apache.lenya.ac.User getUser(org.apache.cocoon.environment.Request request, java.lang.String[] parameters, org.apache.lenya.ac.Identity identity) throws org.apache.avalon.framework.configuration.ConfigurationException
request
- The request.parameters
- The parameters.identity
- The logged in identity.
null
if no user is specified or logged in.
org.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs.public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) throws org.apache.avalon.framework.configuration.ConfigurationException
getAttributeNames
in interface org.apache.cocoon.components.modules.input.InputModule
getAttributeNames
in class org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.avalon.framework.configuration.ConfigurationException
InputModule.getAttributeNames(org.apache.avalon.framework.configuration.Configuration,
java.util.Map)
public java.lang.Object[] getAttributeValues(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) throws org.apache.avalon.framework.configuration.ConfigurationException
getAttributeValues
in interface org.apache.cocoon.components.modules.input.InputModule
getAttributeValues
in class org.apache.cocoon.components.modules.input.AbstractInputModule
org.apache.avalon.framework.configuration.ConfigurationException
InputModule.getAttributeValues(java.lang.String,
org.apache.avalon.framework.configuration.Configuration, java.util.Map)
protected org.apache.lenya.ac.ItemManager getItemManager(org.apache.cocoon.environment.Request request, java.lang.String name) throws org.apache.avalon.framework.configuration.ConfigurationException
request
- The request.name
- The name of the manager (USER_MANAGER
, ROLE_MANAGER
,
GROUP_MANAGER
, or IP_RANGE_MANAGER
org.apache.avalon.framework.configuration.ConfigurationException
- when something went wrong.public void service(org.apache.avalon.framework.service.ServiceManager _manager) throws org.apache.avalon.framework.service.ServiceException
service
in interface org.apache.avalon.framework.service.Serviceable
org.apache.avalon.framework.service.ServiceException
Serviceable.service(org.apache.avalon.framework.service.ServiceManager)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |