|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ws.webservices.engine.client.Stub
com.ibm.soa.parlayx21.group.GroupBindingStub
public class GroupBindingStub
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 |
---|
public GroupBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service) throws com.ibm.ws.webservices.engine.WebServicesFault
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail |
---|
public void addMember(java.net.URI group, java.net.URI member) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
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.
addMember
in interface Group
group
- xsd:anyURI
URI of groupmember
- xsd:anyURI
Member to add to the group
java.rmi.RemoteException
PolicyException
ServiceException
public void addMembers(java.net.URI group, java.net.URI[] members) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
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.
addMembers
in interface Group
group
- xsd:anyURI
URI of groupmembers
- xsd:anyURI [1..unbounded]
Member(s) to add to the group
java.rmi.RemoteException
PolicyException
ServiceException
public void deleteMember(java.net.URI group, java.net.URI member) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
deleteMember
in interface Group
group
- xsd:anyURI
URI of groupmember
- xsd:anyURI
Member to delete from the group
java.rmi.RemoteException
PolicyException
ServiceException
public void deleteMembers(java.net.URI group, java.net.URI[] members) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
deleteMembers
in interface Group
group
- xsd:anyURI
URI of groupmembers
- xsd:anyURI [1..unbounded]
Member(s) to delete from the group
java.rmi.RemoteException
PolicyException
ServiceException
public java.net.URI[] queryMembers(java.net.URI group, boolean resolveGroups) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
queryMembers
in interface Group
group
- xsd:anyURI
URI of groupresolveGroups
- xsd:boolean
If true, return set of members after resolving groups (including subgroups). If false, return members including group references
java.rmi.RemoteException
PolicyException
ServiceException
public void addGroupAttribute(java.net.URI group, SimpleAttribute value) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
addGroupAttribute
in interface Group
group
- xsd:anyURI
Group to set attribute forvalue
- SimpleAttribute
Attribute to add, or update
java.rmi.RemoteException
PolicyException
ServiceException
public void deleteGroupAttribute(java.net.URI group, java.lang.String attributeName) throws java.rmi.RemoteException, PolicyException, ServiceException
Group
Groups may have attributes removed by those with admin or delete permission on the specified group.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
deleteGroupAttribute
in interface Group
group
- xsd:anyURI
Group to delete attribute fromattributeName
- xsd:string
Name of attribute to delete
java.rmi.RemoteException
PolicyException
ServiceException
public SimpleAttribute[] queryGroupAttributes(java.net.URI group) throws java.rmi.RemoteException, PolicyException, ServiceException
Group
Query the attributes for a group by those with admin or read permission on the specified group.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
queryGroupAttributes
in interface Group
group
- xsd:anyURI
Group to get attributes for
java.rmi.RemoteException
PolicyException
ServiceException
public void addGroupMemberAttribute(java.net.URI group, java.net.URI member, SimpleAttribute value) throws java.rmi.RemoteException, PolicyException, ServiceException
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.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
addGroupMemberAttribute
in interface Group
group
- xsd:anyURI
Group to set attribute formember
- xsd:anyURI
Member to set attribute forvalue
- SimpleAttribute
Attribute to add, or update
java.rmi.RemoteException
PolicyException
ServiceException
public void deleteGroupMemberAttribute(java.net.URI group, java.net.URI member, java.lang.String attributeName) throws java.rmi.RemoteException, PolicyException, ServiceException
Group
Group members may have attributes removed by those with admin or delete permission on the specified group.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
deleteGroupMemberAttribute
in interface Group
group
- xsd:anyURI
Group to delete attribute frommember
- xsd:anyURI
Member to delete attribute fromattributeName
- xsd:string
Name of attribute to remove
java.rmi.RemoteException
PolicyException
ServiceException
public SimpleAttribute[] queryGroupMemberAttributes(java.net.URI group, java.net.URI member) throws java.rmi.RemoteException, PolicyException, ServiceException
Group
Query the attributes for a group member by those with admin or read permission on the specified group.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
queryGroupMemberAttributes
in interface Group
group
- xsd:anyURI
Group to get attributes formember
- xsd:anyURI
Member to get attributes for
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |