java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.usermanagement.commands.MemberRoleAssignCmdImpl
The MemberRoleAssign command assigns roles for a member to orgentities.
The member can be a user, organization or organizational unit. Assigning roles to organization or organizational unit means that users who belong to an organization or organizational unit can take on roles assigned to that organization. In this case, the memberId and organEntityId should be same.
The assignment is stored in the MBRROLE table.
Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.
The parameter URL and memberId are mandatory.
Behavior
Exception Conditions
Field Summary | |
---|---|
protected
boolean |
bCheckURL Whether the URL parameter needs to be specified. |
protected
boolean |
bToolsFramework Whether this command is called by the tools framework. |
static java.lang.String |
CLASSNAME The name of this implementation of the command. |
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
protected
OrganizationAccessBean |
iabOrgEntity The organization access bean of the organization having the role assigned to. |
protected
UserAccessBean |
iabUser The user access bean of the user having the role assigned to. |
protected
boolean |
ibOrgEntity Whether an organization is having the roles assigned or a user. |
protected
java.lang.Long |
inMemberId The long representation of the member identifier. |
protected
java.lang.String |
istrMemberId The string representation of the member identifier. |
protected
java.util.Vector |
ivecOrgEntityId A list of organization entity identifiers. |
protected
java.util.Vector |
ivecRoleId A list of role identifiers. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.usermanagement.commands. MemberRoleAssignCmd |
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
MemberRoleAssignCmdImpl() |
Method Summary | |
---|---|
void |
checkIsAllowed(
AccessVector resource, java.lang.String action) Check if the access control by calling checkIsAllowed() in the super classes |
boolean |
getCheckURL() Returns whether the URL needs to be specified. |
java.lang.String |
getMemberId() Returns the member identifier of the member having the role assigned to. |
java.util.Vector |
getOrgEntities() Returns a list organization entity identifiers. |
AccessVector |
getResources() Returns the resources that needs to be checked before the command is executed for access control. |
java.util.Vector |
getRoles() Returns a list of role identifiers. |
TypedProperty |
getViewInputProperties() Returns the request properties with the tool framework objects removed. |
void |
performExecute() Assigns the specified member to the specified role. |
void |
reset() Resets the command to its original state so the object can be reused to assign a role to a member. |
void |
setCheckURL(boolean abCheckURL) Sets whether the URL needs to be specified. |
void |
setMemberId(java.lang.String astrMemberId) Sets the member identifier. |
void |
setRequestProperties(
TypedProperty reqProperties) Sets the request properties. |
void |
validateParameters() Validates the parameters passed to the command before the role is assigned to the member. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
protected java.lang.String istrMemberId
protected java.lang.Long inMemberId
protected java.util.Vector ivecRoleId
protected java.util.Vector ivecOrgEntityId
protected UserAccessBean iabUser
protected OrganizationAccessBean iabOrgEntity
protected boolean ibOrgEntity
protected boolean bCheckURL
protected boolean bToolsFramework
Constructor Detail |
---|
public MemberRoleAssignCmdImpl()
Method Detail |
---|
public boolean getCheckURL()
getCheckURL
in interface
MemberRoleAssignCmd
public java.lang.String getMemberId()
getMemberId
in interface
MemberRoleAssignCmd
public java.util.Vector getOrgEntities()
getOrgEntities
in interface
MemberRoleAssignCmd
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public java.util.Vector getRoles()
getRoles
in interface
MemberRoleAssignCmd
public TypedProperty getViewInputProperties()
getViewInputProperties
in interface
ControllerCommand
getViewInputProperties
in class
ControllerCommandImpl
public void checkIsAllowed(AccessVector resource, java.lang.String action) throws ECException
resource
- The resource.action
- The action.Throws
- ECSystemException.ECException
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- If there was a problem assigning the member to the role or executing the
PostMemberRoleAssign command.public void reset()
reset
in interface
MemberRoleAssignCmd
reset
in class
AbstractECTargetableCommand
public void setCheckURL(boolean abCheckURL)
setCheckURL
in interface
MemberRoleAssignCmd
abCheckURL
- whether the URL needs to be
specified.public void setMemberId(java.lang.String astrMemberId)
setMemberId
in interface
MemberRoleAssignCmd
astrMemberId
- the member identifier.public void setRequestProperties(TypedProperty reqProperties) throws ECException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqProperties
- the parameters passed to the command.ECException
- If there was any invalid parameter specified or a problem indicated by the
PreMemberRoeAssign command.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- If either the role or the member does exist, an ECApplicationException will
be thrown.