com.ibm.soa.parlayx21.group
Class GroupBindingStub

java.lang.Object
  extended by com.ibm.ws.webservices.engine.client.Stub
      extended by com.ibm.soa.parlayx21.group.GroupBindingStub
All Implemented Interfaces:
Group, java.rmi.Remote, javax.xml.rpc.Stub

public class GroupBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements Group


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub
com.ibm.ws.webservices.engine.client.Stub.Invoke
 
Field Summary
 
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
GroupBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void addGroupAttribute(java.net.URI group, SimpleAttribute value)
          Groups may have attributes associated with the group.
 void addGroupMemberAttribute(java.net.URI group, java.net.URI member, SimpleAttribute value)
          Group members may have attributes that are within the context of a group in which they belong.
 void addMember(java.net.URI group, java.net.URI member)
          Add a member to a group.
 void addMembers(java.net.URI group, java.net.URI[] members)
          Add an array of members to a group.
 void deleteGroupAttribute(java.net.URI group, java.lang.String attributeName)
          Groups may have attributes removed by those with admin or delete permission on the specified group.
 void deleteGroupMemberAttribute(java.net.URI group, java.net.URI member, java.lang.String attributeName)
          Group members may have attributes removed by those with admin or delete permission on the specified group.
 void deleteMember(java.net.URI group, java.net.URI member)
          Delete a member from a group.
 void deleteMembers(java.net.URI group, java.net.URI[] members)
          Delete an array of members from a group.
 SimpleAttribute[] queryGroupAttributes(java.net.URI group)
          Query the attributes for a group by those with admin or read permission on the specified group.
 SimpleAttribute[] queryGroupMemberAttributes(java.net.URI group, java.net.URI member)
          Query the attributes for a group member by those with admin or read permission on the specified group.
 java.net.URI[] queryMembers(java.net.URI group, boolean resolveGroups)
          Get the list of members contained within a group.
 
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupBindingStub

public GroupBindingStub(java.net.URL endpointURL,
                        javax.xml.rpc.Service service)
                 throws com.ibm.ws.webservices.engine.WebServicesFault
Throws:
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail

addMember

public void addMember(java.net.URI group,
                      java.net.URI member)
               throws java.rmi.RemoteException,
                      PolicyException,
                      ServiceException
Description copied from interface: Group

Add a member to a group. If the new member is a group, and if nested group support is provided, this will add the group URI as a reference to the list of members (it will not expand the contents of the group within this group). A group may not be added recursively, an attempt to do so will result in a ServiceException.

To add a group as a member of a group, the requester must have query permission on the group to be added.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0210: Too many members in group.
  * POL0211: Subgroups not allowed.

Specified by:
addMember in interface Group
Parameters:
group - xsd:anyURI URI of group
member - xsd:anyURI Member to add to the group
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

addMembers

public void addMembers(java.net.URI group,
                       java.net.URI[] members)
                throws java.rmi.RemoteException,
                       PolicyException,
                       ServiceException
Description copied from interface: Group

Add an array of members to a group. If nested group support is provided, this will add any group URIs, as references, to the list of members (it will not expand the contents of any groups within this group). No group may be added recursively, an attempt to do so will result in a ServiceException, and none of the members will be added to the group.

To add a group as a member of a group, the requester must have query permission on the group to be added.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0210: Too many members in group.
  * POL0211: Subgroups not allowed.

Specified by:
addMembers in interface Group
Parameters:
group - xsd:anyURI URI of group
members - xsd:anyURI [1..unbounded] Member(s) to add to the group
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

deleteMember

public void deleteMember(java.net.URI group,
                         java.net.URI member)
                  throws java.rmi.RemoteException,
                         PolicyException,
                         ServiceException
Description copied from interface: Group

Delete a member from a group. The member may only be removed from this group. If nested groups are supported, the member will not be removed from any nested group. Removal of a group URI will remove that group URI reference from this group, is will not delete the group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
deleteMember in interface Group
Parameters:
group - xsd:anyURI URI of group
member - xsd:anyURI Member to delete from the group
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

deleteMembers

public void deleteMembers(java.net.URI group,
                          java.net.URI[] members)
                   throws java.rmi.RemoteException,
                          PolicyException,
                          ServiceException
Description copied from interface: Group

Delete an array of members from a group. The members may only be removed from this group. If nested groups are supported, the members will not be removed from any nested group. Removal of a group URI will remove that group URI reference from this group, it will not delete the group. If the array contains URIs that are not in the group, they will be ignored and no fault will be generated.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
deleteMembers in interface Group
Parameters:
group - xsd:anyURI URI of group
members - xsd:anyURI [1..unbounded] Member(s) to delete from the group
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

queryMembers

public java.net.URI[] queryMembers(java.net.URI group,
                                   boolean resolveGroups)
                            throws java.rmi.RemoteException,
                                   PolicyException,
                                   ServiceException
Description copied from interface: Group

Get the list of members contained within a group.

If nested groups are supported, then the member list may contain group URIs as members. Therefore, two manners are supported for retrieving the list of members - with members resolved and without.
  * If resolveGroups is 'true', then the exclusive union of all the members contained within the group, and any nested subgroups, is the result (exclusive union means that after retrieving all members, duplicate members are removed).
  * If resolveGroups is 'false', then the group members are returned including group URIs as members of the group. If members within nested groups are required, subsequent calls to this operation with those groups may be used to retrieve those members.

If nested groups are not supported, the value of resolveGroups is ignored.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
queryMembers in interface Group
Parameters:
group - xsd:anyURI URI of group
resolveGroups - xsd:boolean If true, return set of members after resolving groups (including subgroups). If false, return members including group references
Returns:
membersresult xsd:anyURI [0..unbounded] Members of group
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

addGroupAttribute

public void addGroupAttribute(java.net.URI group,
                              SimpleAttribute value)
                       throws java.rmi.RemoteException,
                              PolicyException,
                              ServiceException
Description copied from interface: Group

Groups may have attributes associated with the group. To avoid conflicts, attribute names that start with Group are reserved for use as defined within the present document:
  * Group.Description.
  * Group.ExpiryDate.

Attributes may be added or updated by those with admin or add permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
addGroupAttribute in interface Group
Parameters:
group - xsd:anyURI Group to set attribute for
value - SimpleAttribute Attribute to add, or update
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

deleteGroupAttribute

public void deleteGroupAttribute(java.net.URI group,
                                 java.lang.String attributeName)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
Description copied from interface: Group

Groups may have attributes removed by those with admin or delete permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
deleteGroupAttribute in interface Group
Parameters:
group - xsd:anyURI Group to delete attribute from
attributeName - xsd:string Name of attribute to delete
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

queryGroupAttributes

public SimpleAttribute[] queryGroupAttributes(java.net.URI group)
                                       throws java.rmi.RemoteException,
                                              PolicyException,
                                              ServiceException
Description copied from interface: Group

Query the attributes for a group by those with admin or read permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
queryGroupAttributes in interface Group
Parameters:
group - xsd:anyURI Group to get attributes for
Returns:
result SimpleAttribute [0..unbounded] Group attributes
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

addGroupMemberAttribute

public void addGroupMemberAttribute(java.net.URI group,
                                    java.net.URI member,
                                    SimpleAttribute value)
                             throws java.rmi.RemoteException,
                                    PolicyException,
                                    ServiceException
Description copied from interface: Group

Group members may have attributes that are within the context of a group in which they belong.

Group member attributes may be added or updated by those with admin or add permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
addGroupMemberAttribute in interface Group
Parameters:
group - xsd:anyURI Group to set attribute for
member - xsd:anyURI Member to set attribute for
value - SimpleAttribute Attribute to add, or update
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

deleteGroupMemberAttribute

public void deleteGroupMemberAttribute(java.net.URI group,
                                       java.net.URI member,
                                       java.lang.String attributeName)
                                throws java.rmi.RemoteException,
                                       PolicyException,
                                       ServiceException
Description copied from interface: Group

Group members may have attributes removed by those with admin or delete permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
deleteGroupMemberAttribute in interface Group
Parameters:
group - xsd:anyURI Group to delete attribute from
member - xsd:anyURI Member to delete attribute from
attributeName - xsd:string Name of attribute to remove
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

queryGroupMemberAttributes

public SimpleAttribute[] queryGroupMemberAttributes(java.net.URI group,
                                                    java.net.URI member)
                                             throws java.rmi.RemoteException,
                                                    PolicyException,
                                                    ServiceException
Description copied from interface: Group

Query the attributes for a group member by those with admin or read permission on the specified group.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.

Specified by:
queryGroupMemberAttributes in interface Group
Parameters:
group - xsd:anyURI Group to get attributes for
member - xsd:anyURI Member to get attributes for
Returns:
result SimpleAttribute [0..unbounded] Group member attributes
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.