org.dogtagpki.server.rest

Class GroupService

java.lang.Object

com.netscape.cms.servlet.base.PKIService

org.dogtagpki.server.rest.GroupService

All Implemented Interfaces:

GroupResource

public class GroupService
extends PKIService
implements GroupResource

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field and Description
IUGSubsystem	userGroupManager

Fields inherited from class com.netscape.cms.servlet.base.PKIService

auditor, DEFAULT_LONG_CACHE_LIFETIME, DEFAULT_SIZE, logger, MESSAGE_FORMATS, MIN_FILTER_LENGTH

Constructor Summary

Constructors

Constructor and Description
GroupService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addGroup(GroupData groupData) Adds a new group in local scope.
javax.ws.rs.core.Response	addGroupMember(java.lang.String groupID, GroupMemberData groupMemberData)
void	audit(java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String status)
void	auditAddGroup(java.lang.String groupID, GroupData groupData, java.lang.String status)
void	auditDeleteGroup(java.lang.String groupID, java.lang.String status)
void	auditModifyGroup(java.lang.String groupID, GroupData groupData, java.lang.String status)
GroupData	createGroupData(IGroup group)
javax.ws.rs.core.Response	findGroupMembers(java.lang.String groupID, java.lang.String filter, java.lang.Integer start, java.lang.Integer size)
javax.ws.rs.core.Response	findGroups(java.lang.String filter, java.lang.Integer start, java.lang.Integer size) Searches for users in LDAP directory.
javax.ws.rs.core.Response	getGroup(java.lang.String groupID) finds a group Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin
GroupData	getGroupData(java.lang.String groupID)
javax.ws.rs.core.Response	getGroupMember(java.lang.String groupID, java.lang.String memberID)
void	log(int level, java.lang.String message)
javax.ws.rs.core.Response	modifyGroup(java.lang.String groupID, GroupData groupData) modifies a group
javax.ws.rs.core.Response	removeGroup(java.lang.String groupID) removes a group
javax.ws.rs.core.Response	removeGroupMember(java.lang.String groupID, java.lang.String memberID)

Methods inherited from class com.netscape.cms.servlet.base.PKIService

audit, createCreatedResponse, createNoContentResponse, createOKResponse, createOKResponse, getLocale, getParams, getResponseFormat, getResponseFormat, getUserMessage, log, resolveFormat, resolveFormat, sendConditionalGetResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userGroupManager

public IUGSubsystem userGroupManager

Constructor Detail

GroupService

public GroupService()

Method Detail

createGroupData

public GroupData createGroupData(IGroup group)
                          throws java.lang.Exception

Throws:

java.lang.Exception

findGroups

public javax.ws.rs.core.Response findGroups(java.lang.String filter,
                                            java.lang.Integer start,
                                            java.lang.Integer size)

Searches for users in LDAP directory. Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

Specified by:

findGroups in interface GroupResource

getGroup

public javax.ws.rs.core.Response getGroup(java.lang.String groupID)

finds a group Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#user-admin

Specified by:

getGroup in interface GroupResource

getGroupData

public GroupData getGroupData(java.lang.String groupID)

addGroup

public javax.ws.rs.core.Response addGroup(GroupData groupData)

Adds a new group in local scope.

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#group

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

addGroup in interface GroupResource

modifyGroup

public javax.ws.rs.core.Response modifyGroup(java.lang.String groupID,
                                             GroupData groupData)

modifies a group

last person of the super power group "Certificate Server Administrators" can never be removed.

http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#group

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

modifyGroup in interface GroupResource

removeGroup

public javax.ws.rs.core.Response removeGroup(java.lang.String groupID)

removes a group

Request/Response Syntax: http://warp.mcom.com/server/certificate/columbo/design/ ui/admin-protocol-definition.html#group

• signed.audit LOGGING_SIGNED_AUDIT_CONFIG_ROLE used when configuring role information (anything under users/groups)

Specified by:

removeGroup in interface GroupResource

findGroupMembers

public javax.ws.rs.core.Response findGroupMembers(java.lang.String groupID,
                                                  java.lang.String filter,
                                                  java.lang.Integer start,
                                                  java.lang.Integer size)

Specified by:

findGroupMembers in interface GroupResource

getGroupMember

public javax.ws.rs.core.Response getGroupMember(java.lang.String groupID,
                                                java.lang.String memberID)

Specified by:

getGroupMember in interface GroupResource

addGroupMember

public javax.ws.rs.core.Response addGroupMember(java.lang.String groupID,
                                                GroupMemberData groupMemberData)

Specified by:

addGroupMember in interface GroupResource

removeGroupMember

public javax.ws.rs.core.Response removeGroupMember(java.lang.String groupID,
                                                   java.lang.String memberID)

Specified by:

removeGroupMember in interface GroupResource

log

public void log(int level,
                java.lang.String message)

auditAddGroup

public void auditAddGroup(java.lang.String groupID,
                          GroupData groupData,
                          java.lang.String status)

auditModifyGroup

public void auditModifyGroup(java.lang.String groupID,
                             GroupData groupData,
                             java.lang.String status)

auditDeleteGroup

public void auditDeleteGroup(java.lang.String groupID,
                             java.lang.String status)

audit

public void audit(java.lang.String type,
                  java.lang.String id,
                  java.util.Map<java.lang.String,java.lang.String> params,
                  java.lang.String status)