com.ibm.eserver.zos.racf.userregistry
Class RACF_Group

java.lang.Object
  extended bycom.ibm.eserver.zos.racf.userregistry.RACF_Group
All Implemented Interfaces:
Group, Principal, UserGroup

public class RACF_Group
extends Object
implements UserGroup

Implements UserGroup interface for RACF groups. Additionally provides attributesInfo method. RACF does not currently support adding a group as a member of another group. Therefore, the Principal user input to the addMember method cannot implement the Group interface. If an object implementing Group is passed as as input to addMember or addMembers, an illegalArgumentException will be thrown.

See Also:
Group.addMember(java.security.Principal)

Field Summary
static String COPYRIGHT
           
static String sccsid
           
 
Method Summary
 boolean addMember(Principal user)
          Adds user to group, implementing addMember method of java.security.acl.Group interface
 boolean addMember(Principal user, BasicAttributes in_attributes)
          Adds user to group with specified membership attributes.
static String attributesHTML()
          Returns an HTML table of group attributes and their properties.
static BasicAttributes attributesInfo()
          Returns group attributes and their properties.
 BasicAttributes getAttributes()
          Gets the attributes for this group
 BasicAttributes getMembershipAttributes(Principal member)
          Returns membership attributes of specified member to this group from security repository
 String getName()
          Returns the name of this group.
 boolean isMember(Principal member)
          Returns true if the passed principal is a member of the group
 Enumeration members()
          Returns an enumeration of the members in the group.
static String membershipAttributesHTML()
          Returns an HTML table of membership attributes and their properties.
static BasicAttributes membershipAttributesInfo()
          Returns membership attributes and their properties.
 void modifyMembershipAttributes(Principal user, ModificationItem[] input_mods)
          Modify membership attributes of specified member of this group in security repository
 boolean removeMember(Principal user)
          Removes specified member from the group.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.security.Principal
equals, hashCode, toString
 

Field Detail

COPYRIGHT

public static final String COPYRIGHT
See Also:
Constant Field Values

sccsid

public static final String sccsid
See Also:
Constant Field Values
Method Detail

addMember

public boolean addMember(Principal user)
Adds user to group, implementing addMember method of java.security.acl.Group interface

Specified by:
addMember in interface UserGroup
Parameters:
user - Principal object for user we are adding to group
Returns:
true if user added to group, false if user was already a member of group.
See Also:
Group.addMember(java.security.Principal)

addMember

public boolean addMember(Principal user,
                         BasicAttributes in_attributes)
                  throws SecAdminException
Adds user to group with specified membership attributes.

Specified by:
addMember in interface UserGroup
Parameters:
user - Principal object for user we are adding to group
in_attributes - BasicAttributes containing membership attributes to set for user's membership in group
Returns:
true if user added to group, false if user was already a member of group. If user already a member of group, membership attributes will be updated with any new attributes.
Throws:
SecAdminException

attributesHTML

public static String attributesHTML()
Returns an HTML table of group attributes and their properties. Includes whether attributes are modifiable, brief description etc. The brief description returned by attributesHTML is meant to serve as reminder of meaning of attribute. For full description and additional usage information, one should refer to corresponding section of ADDGROUP or ALTGROUP documentation in RACF Command Language Reference.

Returns:
String containing HTML table

attributesInfo

public static BasicAttributes attributesInfo()
Returns group attributes and their properties. attributesInfo returns each attribute that could be returned by getAttributes. The values of each attribute are properties or characteristics of the attribute, such as description, whether attribute is modifiable, is attribute multi-value, etc

Returns:
BasicAttributes with same names (IDs) as BasicAttributes returned by getAttributes but values are characteristics of the attribute, not specific group data

getAttributes

public BasicAttributes getAttributes()
                              throws SecAdminException
Gets the attributes for this group

Specified by:
getAttributes in interface UserGroup
Throws:
SecAdminException

getMembershipAttributes

public BasicAttributes getMembershipAttributes(Principal member)
                                        throws SecAdminException
Description copied from interface: UserGroup
Returns membership attributes of specified member to this group from security repository

Specified by:
getMembershipAttributes in interface UserGroup
Parameters:
member - member to retrieve membership attributes for
Throws:
SecAdminException

getName

public String getName()
Description copied from interface: UserGroup
Returns the name of this group. Value returned by getName would equal the groupname used on SecAdmin.getGroup(groupname)

Specified by:
getName in interface UserGroup
See Also:
Principal.getName()

isMember

public boolean isMember(Principal member)
Description copied from interface: UserGroup
Returns true if the passed principal is a member of the group

Specified by:
isMember in interface UserGroup
See Also:
Group.isMember(java.security.Principal)

members

public Enumeration members()
Returns an enumeration of the members in the group. Each element in the enumeration is a RACF_User object.

Specified by:
members in interface UserGroup
See Also:
Group.members()

membershipAttributesHTML

public static String membershipAttributesHTML()
Returns an HTML table of membership attributes and their properties. Includes whether attributes are modifiable, brief description etc. The brief description returned by attributesHTML is meant to serve as reminder of meaning of attribute. For full description and additional usage information, one should refer to corresponding section of CONNECT documentation in RACF Command Language Reference.

Returns:
String containing HTML table

membershipAttributesInfo

public static BasicAttributes membershipAttributesInfo()
Returns membership attributes and their properties. attributesInfo returns each attribute that could be returned by getMembershipAttributes. The values of each attributes are properties or characteristics of the attribute, such as description, whether attribute is modifiable, is attribute multi-value, etc

Returns:
BasicAttributes with same names as BasicAttributes returned by getAttributes but values are characteristics of the attribute, not specific membership data

modifyMembershipAttributes

public void modifyMembershipAttributes(Principal user,
                                       ModificationItem[] input_mods)
                                throws SecAdminException
Description copied from interface: UserGroup
Modify membership attributes of specified member of this group in security repository

Specified by:
modifyMembershipAttributes in interface UserGroup
Parameters:
user - member to modify
Throws:
SecAdminException

removeMember

public boolean removeMember(Principal user)
Description copied from interface: UserGroup
Removes specified member from the group.

Specified by:
removeMember in interface UserGroup
See Also:
Group.removeMember(java.security.Principal)