CreateGroupTag Class

com.bea.p13n.usermgmt.taglib
CreateGroupTag Class

public class CreateGroupTag

    extends ResultTag

Corresponds to <ugm:createGroup>.

The <ugm:createGroup> tag creates a new group. The tag has no enclosed body.

Tag Attribute

Required

Type

Description

atnProvider

no

String

The name of the authentication provider in which the group will be created.

The default provider will be used if not specified.

Example: "<%=atnProvider%>"

groupName

yes

String

The name of the new group.

Example: "<%=groupName%>"

id

no

String

A variable name to which the created Group object is available for the duration of the page's scope.

parentName

no

String

The new group name.

result

yes

String

The name of an Integer variable to which the result of the create group operation is assigned.

Possible values:
Success:
UserManagerTagConstants.CREATE_GROUP_OK

Error Encountered:
UserManagerTagConstants.CREATE_GROUP_FAILED

A group with the specified group name already exists:
UserManagerTagConstants.GROUP_EXISTS


Hierarchy
Object
  TagSupport
    UserManagementTag
      ResultTag
        CreateGroupTag
All Implemented Interfaces

IterationTag, Serializable, Tag, UserManagementTagConstants

Field Summary

   
Fields from  com.bea.p13n.usermgmt.taglib.ResultTag
result
 
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Fields from interface com.bea.p13n.usermgmt.taglib.UserManagementTagConstants
ADD_GROUP_FAILED, ADD_GROUP_OK, ADD_USER_FAILED, ADD_USER_OK, CREATE_GROUP_FAILED, CREATE_GROUP_OK, CREATE_USER_FAILED, CREATE_USER_OK, DEFAULT_SEARCH_EXP, DEFAULT_USER_LIMIT, GET_PROFILE_FAILED, GET_PROFILE_OK, GROUP_CHANGE_FAILED, GROUP_CHANGE_OK, GROUP_EXISTS, LOGIN_ERROR, LOGIN_FAILED, LOGIN_OK, NO_SUCH_PROFILE, NO_SUCH_SUCCESSOR, REMOVE_GROUP_FAILED, REMOVE_GROUP_OK, REMOVE_USER_FAILED, REMOVE_USER_OK, RESERVED_GROUP_NAME, RESERVED_USER_NAME, SET_PASSWORD_FAILED, SET_PASSWORD_OK, SET_PROPERTY_FAILED, SET_PROPERTY_OK, USER_EXISTS, USER_LIMIT_EXCEEDED, USER_SEARCH_FAILED, USER_SEARCH_OK
 

Constructor Summary

CreateGroupTag()

 

Method Summary

public int
doStartTag()
Go through the UserManager session bean to create the new group, and optionally add it to the specified parent group.
public String
getAtnProvider()
Get the name of the authentication provider
public String
getGroupName()
Get the name of the group to create
public String
getParentName()
Get the name of the group to add the new group to
public void
release()
Reset tag attributes
public void
setAtnProvider(String atnProvider)
Set the name of the authentication provider
public void
setGroupName(String groupName)
Set the name of the group to create
public void
setParentName(String parentName)
Set the name of the group to add the new group to
 
Methods from  com.bea.p13n.usermgmt.taglib.ResultTag
getResult, setResult
 
Methods from  com.bea.p13n.usermgmt.taglib.UserManagementTag
getAtnManagerProxy, release
 
Methods from  javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Constructor Detail

CreateGroupTag

public CreateGroupTag()
 

Method Detail

doStartTag() Method

public int doStartTag()
throws JspException
Go through the UserManager session bean to create the new group, and optionally add it to the specified parent group.

Overrides
TagSupport.doStartTag()

Exceptions

JspException

getAtnProvider() Method

public String getAtnProvider()
Get the name of the authentication provider


getGroupName() Method

public String getGroupName()
Get the name of the group to create


getParentName() Method

public String getParentName()
Get the name of the group to add the new group to


release() Method

public void release()
Reset tag attributes

Overrides
ResultTag.release()

setAtnProvider(String) Method

public void setAtnProvider(String atnProvider)
Set the name of the authentication provider


setGroupName(String) Method

public void setGroupName(String groupName)
Set the name of the group to create


setParentName(String) Method

public void setParentName(String parentName)
Set the name of the group to add the new group to