dm.soap.services.group

Class DmSoapGroup

java.lang.Object

DmSoapService

dm.soap.services.group.DmSoapGroup

Direct Known Subclasses:

DmSoapSamlGroup

@MTOM(enabled=true,
      threshold=2048)
public class DmSoapGroup
extends DmSoapService

This SOAP service is used to expose all Group related TechDoc operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.ws.WebServiceContext	_context The WebServiceContext that called this service.

Constructor Summary

Constructors

Constructor and Description
DmSoapGroup()

Method Summary

Modifier and Type	Method and Description
void	associateAccessForGroup(java.lang.String name, java.util.ArrayList<StringPair> users, java.lang.String reason) Web service operation for the AssociateAccessCmd.
int	createExternalGroup(GroupInfo groupInfo, java.lang.String reason) Web service operation for the CreateGroupCmd.
int	createLocalUserGroup(GroupInfo groupInfo, java.lang.String reason) Web service operation for the CreateGroupCmd.
int	createRemoteEmailGroup(GroupInfo groupInfo, java.lang.String reason) Web service operation for the CreateGroupCmd.
int	createRemoteUserGroup(GroupInfo groupInfo, java.lang.String reason) Web service operation for the CreateGroupCmd.
void	deleteGroup(java.lang.String name, java.lang.String reason) Web service operation for the DeleteGroupCmd.
boolean	exists(java.lang.String name) Web service operation to see if the specified group exists.
void	modifyGroup(java.lang.String name, GroupInfo newGroupInfo, java.lang.String reason) Web service operation for the ModifyGroupCmd.
StringPair[]	showAssociationsForGroup(java.lang.String name, java.lang.String reason) Web service operation for the ShowAssociationsCmd.
GroupInfo	showGroup(java.lang.String name) Web service operation for the ShowGroupCmd.

Methods inherited from class java.lang.Object

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

Field Detail

_context

protected javax.xml.ws.WebServiceContext _context

The WebServiceContext that called this service.

Constructor Detail

DmSoapGroup

public DmSoapGroup()

Method Detail

associateAccessForGroup

public void associateAccessForGroup(java.lang.String name,
                                    java.util.ArrayList<StringPair> users,
                                    java.lang.String reason)
                             throws DmSoapException

Web service operation for the AssociateAccessCmd.

Parameters:

name - The group name.

users - An ArrayList containing user names or null if no users should be associated to this group.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

createLocalUserGroup

public int createLocalUserGroup(GroupInfo groupInfo,
                                java.lang.String reason)
                         throws DmSoapException

Web service operation for the CreateGroupCmd.

Parameters:

groupInfo - A GroupInfo object for the group to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The unique ID of the group created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

createExternalGroup

public int createExternalGroup(GroupInfo groupInfo,
                               java.lang.String reason)
                        throws DmSoapException

Web service operation for the CreateGroupCmd.

Parameters:

groupInfo - A GroupInfo object for the group to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The unique ID of the group created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

createRemoteEmailGroup

public int createRemoteEmailGroup(GroupInfo groupInfo,
                                  java.lang.String reason)
                           throws DmSoapException

Web service operation for the CreateGroupCmd.

Parameters:

groupInfo - A GroupInfo object for the group to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The unique ID of the group created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

createRemoteUserGroup

public int createRemoteUserGroup(GroupInfo groupInfo,
                                 java.lang.String reason)
                          throws DmSoapException

Web service operation for the CreateGroupCmd.

Parameters:

groupInfo - A GroupInfo object for the group to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The unique ID of the group created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

deleteGroup

public void deleteGroup(java.lang.String name,
                        java.lang.String reason)
                 throws DmSoapException

Web service operation for the DeleteGroupCmd.

Parameters:

name - The group name.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

exists

public boolean exists(java.lang.String name)
               throws DmSoapException

Web service operation to see if the specified group exists.

Parameters:

name - The group name.

Returns:

true if the group exists; false otherwise.

Throws:

DmSoapException - A DmSoapException if an error occurs.

modifyGroup

public void modifyGroup(java.lang.String name,
                        GroupInfo newGroupInfo,
                        java.lang.String reason)
                 throws DmSoapException

Web service operation for the ModifyGroupCmd. Obtain the GroupInfo object from showGroup for the group you want to modify. Change what you want, and call modifyGroup with the docNumber and modified DocumentInfo object.

Parameters:

name - The name of the existing group to modify.

newGroupInfo - A modified GroupInfo object.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

showAssociationsForGroup

public StringPair[] showAssociationsForGroup(java.lang.String name,
                                             java.lang.String reason)
                                      throws DmSoapException

Web service operation for the ShowAssociationsCmd.

Parameters:

name - The group name.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

A StringPair object containing the user names and access levels.

Throws:

DmSoapException - A DmSoapException if an error occurs.

showGroup

public GroupInfo showGroup(java.lang.String name)
                    throws DmSoapException

Web service operation for the ShowGroupCmd.

Parameters:

name - The group name.

Returns:

A GroupInfo object.

Throws:

DmSoapException - A DmSoapException if an error occurs.