public class

AppsGroupsService

extends AppsPropertyService

java.lang.Object
↳	com.google.gdata.client.Service
	↳	com.google.gdata.client.GoogleService
		↳	com.google.gdata.client.appsforyourdomain.AppsForYourDomainService
			↳	com.google.gdata.client.appsforyourdomain.AppsPropertyService
				↳	com.google.gdata.client.appsforyourdomain.AppsGroupsService

Class Overview

Service class specializing AppsPropertyService for groups management

Summary

Constants
String	APPS_PROP_GROUP_DESC
String	APPS_PROP_GROUP_EMAIL
String	APPS_PROP_GROUP_ID
String	APPS_PROP_GROUP_MEMBER_ID
String	APPS_PROP_GROUP_NAME
String	APPS_PROP_GROUP_PERMISSION
String	APPS_PROP_GROUP_ROLE
String	BASE_URL

[Expand]

Inherited Constants

From class com.google.gdata.client.appsforyourdomain.AppsForYourDomainService

Fields
public final String	baseDomainUrl

[Expand]

Inherited Fields

From class com.google.gdata.client.GoogleService

From class com.google.gdata.client.Service

Public Constructors
	AppsGroupsService(String adminUser, String adminPassword, String domain, String applicationName) Parameterized constructor to setup a Service object with user credentials.
	AppsGroupsService(String domain, String applicationName) Parameterized constructor to setup a Service object which can be used to initialize the service without obtaining a token.

Public Methods
GenericEntry	addMemberToGroup(String groupId, String memberName) Adds a new member to the group.
GenericEntry	addOwnerToGroup(String groupId, String ownerName) Adds a new member as owner to the group.
GenericEntry	createGroup(String groupId, String groupName, String groupDescription, String emailPermission) Creates a new group in the domain.
void	deleteGroup(String groupId) Deletes a group from the domain.
void	deleteMemberFromGroup(String groupId, String memberName) Removes member subscription to the group.
boolean	doesEntityExist(String feedUrlSuffix) Checks for an available feed from a given Url.
GenericFeed	getNextPage(Link atomLink) Get the next page from the atom:next link
boolean	isMember(String groupId, String memberId) Checks if an user/group is a member of the group specified.
boolean	isOwner(String groupId, String email) Checks if an user is a owner of the group specified.
void	removeOwnerFromGroup(String email, String groupId) Removes an owner from the group.
GenericFeed	retreiveGroupOwners(String groupId) Retrieves all the owners of a given Group.
GenericFeed	retrieveAllGroups() Retrieves all groups in a domain as a GenericFeed.
GenericFeed	retrieveAllMembers(String groupId) Retrieves all the members of a group as a GenericFeed.
List<GenericEntry>	retrieveAllPagesOfGroups() Retrieves all the pages of the groups feed.
GenericEntry	retrieveGroup(String groupId) Retrieves the group details.
GenericFeed	retrieveGroups(String memberName, boolean directOnly) Retrieves all groups of the given member.
GenericFeed	retrievePageOfGroups(Link next) Retrieves next page of groups in a domain as a GenericFeed.
GenericFeed	retrievePageOfMembers(Link next) Retrieves next page of members of a group as a GenericFeed.
GenericEntry	updateGroup(String groupId, String groupName, String groupDescription, String emailPermission) Updates the group properties.

[Expand]

Inherited Methods

From class com.google.gdata.client.appsforyourdomain.AppsForYourDomainService

void	delete(URL entryUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
<E extends IEntry, F extends IFeed> List<E>	getAllPages(URL feedUrl, Class<F> feedClass) Executes a GData query against the target service and returns a List containing all the `IEntry` that match the query result.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince) Returns an Atom entry instance, given the URL of the entry and an if-modified-since date.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
<F extends IFeed> F	query(Query query, Class<F> feedClass) The call to super.getEntry should fall through to Service and the behaviour is unknown if this method is overloaded in GoogleService.
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.

From class com.google.gdata.client.GoogleService

void	addCookie(GoogleGDataRequest.GoogleCookie cookie) Adds a new GoogleCookie instance to the cache.
<F extends IFeed> F	batch(URL feedUrl, F inputFeed) Executes several operations (insert, update or delete) on the entries that are part of the input `IFeed`.
Service.GDataRequest	createRequest(Service.GDataRequest.RequestType type, URL requestUrl, ContentType contentType) Creates a new GDataRequest for use by the service.
Service.GDataRequest	createRequest(Query query, ContentType contentType) Creates a new GDataRequest for querying the service.
void	delete(URL entryUrl, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URL entryUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
String	getAuthToken(String username, String password, String captchaToken, String captchaAnswer, String serviceName, String applicationName) Retrieves the authentication token for the provided set of credentials.
AuthTokenFactory	getAuthTokenFactory() Returns the `AuthTokenFactory` currently associated with the service.
CookieManager	getCookieManager() Returns the `CookieManager` currently associated with the service.
Set<GoogleGDataRequest.GoogleCookie>	getCookies() Returns the set of associated cookies returned by previous requests.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, String etag) Returns an Atom entry instance given the URL of the entry, if its current entity tag is different than the provided value.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince) Returns an Atom entry instance, given the URL of the entry and an if-modified-since date.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed associated with a particular feed URL, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed resulting from executing a query, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, String etag) Returns the Feed resulting from query execution, if if the entity tag associated with it has changed.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, String etag) Returns the Feed associated with a particular feed URL if the entity tag associated with it has changed.
URL	handleRedirectException(RedirectRequiredException redirect) Handles a redirect exception by generating the new URL to use for the redirect.
void	handleSessionExpiredException(GoogleService.SessionExpiredException e) Delegates session expired exception to `AuthTokenFactory`.
boolean	handlesCookies() Returns `true` if the GoogleService is handling cookies.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
static String	makePostRequest(URL url, Map<String, String> parameters) Makes a HTTP POST request to the provided `url` given the provided `parameters`.
void	setAuthSubToken(String token) Sets the AuthSub token to be used to authenticate a user.
void	setAuthSubToken(String token, PrivateKey key) Sets the AuthSub token to be used to authenticate a user.
void	setAuthTokenFactory(AuthTokenFactory authTokenFactory) Sets the `AuthTokenFactory` currently associated with the service.
void	setCookieManager(CookieManager cookieManager) Sets the `CookieManager` currently associated with the service.
void	setHandlesCookies(boolean handlesCookies) Enables or disables cookie handling.
void	setOAuth2Credentials(Credential credential) Sets the OAuth 2.0 credentials used to generate the authorization header.
void	setOAuthCredentials(OAuthParameters parameters, OAuthSigner signer) Sets the OAuth credentials used to generate the authorization header.
void	setUserCredentials(String username, String password, String captchaToken, String captchaAnswer) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password, String captchaToken, String captchaAnswer, ClientLoginAccountType accountType) Sets the credentials of the user to authenticate requests to the server.
void	setUserCredentials(String username, String password, ClientLoginAccountType accountType) Sets the credentials of the user to authenticate requests to the server.
void	setUserToken(String token) Sets the AuthToken that should be used to authenticate requests to the server.
void	tokenChanged(AuthTokenFactory.AuthToken newToken)
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.

From class com.google.gdata.client.Service

<F extends IFeed> F	batch(URL feedUrl, F inputFeed) Executes several operations (insert, update or delete) on the entries that are part of the input `IFeed`.
<T> Class<T>	classOf(T object)
Service.GDataRequest	createBatchRequest(URL feedUrl) Creates a new GDataRequest that can be used to execute several insert/update/delete operations in one request by writing a feed into the request stream to read a feed containing the result of the batch operations from the response stream.
Service.GDataRequest	createDeleteRequest(URL entryUrl) Creates a new GDataRequest that can be used to delete an Atom entry.
Service.GDataRequest	createEntryRequest(URL entryUrl) Returns a GDataRequest instance that can be used to access an entry's contents as a stream, given the URL of the entry.
Service.GDataRequest	createFeedRequest(URL feedUrl) Executes a GData feed request against the target service and returns the resulting feed results via an input stream.
Service.GDataRequest	createFeedRequest(Query query) Executes a GData query request against the target service and returns the resulting feed results via an input stream.
Service.GDataRequest	createInsertRequest(URL feedUrl) Creates a new GDataRequest that can be used to insert a new entry into a feed using the request stream and to read the resulting entry content from the response stream.
Service.GDataRequest	createLinkQueryRequest(ILink link) Returns a query (GET) request that targets the provided link.
Service.GDataRequest	createPatchRequest(URL entryUrl) Creates a new GDataRequest that can be used to update an existing Atom entry.
Service.GDataRequest	createRequest(Service.GDataRequest.RequestType type, URL requestUrl, ContentType inputType) Creates a new GDataRequest for use by the service.
Service.GDataRequest	createRequest(Query query, ContentType inputType) Creates a new GDataRequest for querying the service.
Service.GDataRequest	createUpdateRequest(URL entryUrl) Creates a new GDataRequest that can be used to update an existing Atom entry.
void	delete(URL resourceUrl, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URL resourceUrl) Deletes an existing entry (and associated media content, if any) using the specified edit URL.
void	delete(URI resourceUri, String etag) Deletes an existing entry (and associated media content, if any) using the specified edit URI.
void	delete(URI resourceUri) Deletes an existing entry (and associated media content, if any) using the specified edit URI.
void	endVersionScope()
AltRegistry	getAltRegistry() Returns the alternate registration registry that describes representations that may be parsed from or generated to the remote GData service.
ContentType	getContentType() Returns the default ContentType for data associated with this GData service.
static AltRegistry	getDefaultAltRegistry() Returns an `AltRegistry` instance that is configured with the default parser/generator configuration for a media service.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, String etag) Returns an Atom entry instance given the URL of the entry, if its current entity tag is different than the provided value.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass) Returns an Atom entry instance, given the URL of the entry.
<E extends IEntry> E	getEntry(URL entryUrl, Class<E> entryClass, DateTime ifModifiedSince) Returns an Atom entry instance, given the URL of the entry and an if-modified-since date.
ExtensionProfile	getExtensionProfile() Returns the `ExtensionProfile` that defines any expected extensions to the base RSS/Atom content model.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass) Returns the Feed associated with a particular feed URL.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed associated with a particular feed URL, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, DateTime ifModifiedSince) Returns the Feed resulting from executing a query, if it's been modified since the specified date.
<F extends IFeed> F	getFeed(URL feedUrl, Class<F> feedClass, String etag) Returns the Feed associated with a particular feed URL if the entity tag associated with it has changed.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass) Returns the feed resulting from execution of a query.
<F extends IFeed> F	getFeed(Query query, Class<F> feedClass, String etag) Returns the Feed resulting from query execution, if if the entity tag associated with it has changed.
MetadataRegistry	getMetadataRegistry() Returns the `MetadataRegistry` that defines the expected metadata.
Version	getProtocolVersion() Returns the service protocol version that will be used for requests generated by this service.
Service.GDataRequestFactory	getRequestFactory() Returns the GDataRequestFactory currently associated with the service.
Schema	getSchema() Returns the `Schema` that contains the metadata about element types parsed or generated by this service.
String	getServiceVersion() Returns information about the service version.
InputStream	getStreamFromLink(ILink link) This method is deprecated. Use `createLinkQueryRequest(ILink)` instead.
boolean	getStrictValidation() Returns `true` if strict validation is enabled for this service.
static Version	getVersion() Returns the current `Version` of the GData core protocol.
static Version	initServiceVersion(Class<? extends Service> serviceClass, Version defaultVersion) Initializes the version information for a specific service type.
<E extends IEntry> E	insert(URL feedUrl, E entry) Inserts a new `IEntry` into a feed associated with the target service.
<S extends IServiceDocument> S	introspect(URL feedUrl, Class<S> serviceClass) Returns the Atom introspection Service Document associated with a particular feed URL.
<E> E	parseResponseData(Service.GDataRequest req, Class<E> resultType) Parses the response stream for a request based upon request properties and an expected result type.
<E> E	parseResponseData(ParseSource source, ContentType responseType, Class<E> resultType) Parses the response stream for a request based upon response content type and an expected result type.
<E extends IEntry> E	patch(URL entryUrl, String fields, E entry) Patches an existing `IEntry` by removing a set of selected fields and then merging a partial entry representation into the resource at the specified entry edit URL.
<E extends IEntry> E	patch(URL entryUrl, String fields, E entry, String etag) Patches an existing `IEntry` by removing a set of selected fields and then merging a partial entry representation into the resource at the specified entry edit URL.
<F extends IFeed> F	query(Query query, Class<F> feedClass, String etag) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result if the etag for the target feed does not match the provided value.
<F extends IFeed> F	query(Query query, Class<F> feedClass, DateTime ifModifiedSince) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result, if it's been modified since the specified date.
<F extends IFeed> F	query(Query query, Class<F> feedClass) Executes a GData query against the target service and returns the `IFeed` containing entries that match the query result.
void	setAcceptLanguage(String acceptedLanguages) Defines the languages accepted by the application.
void	setAltRegistry(AltRegistry altRegistry)
void	setConnectTimeout(int timeout) Sets the default wait timeout (in milliseconds) for a connection to the remote GData service.
void	setContentType(ContentType contentType) Sets the default ContentType for writing data to the GData service.
void	setExtensionProfile(ExtensionProfile v) Sets the `ExtensionProfile` that defines any expected extensions to the base RSS/Atom content model.
void	setHeader(String header, String value) Set a header that will be included in all requests.
void	setOAuthProxyHeaders(Map<String, String> headers) Adds OAuth Proxy-related headers to the request.
void	setPrivateHeader(String header, String value) Set a header that will be included in all requests and do not log the value.
void	setProtocolVersion(Version v) Sets the service protocol version that will be used for requests associated with this service.
void	setReadTimeout(int timeout) Sets the default wait timeout (in milliseconds) for a response from the remote GData service.
void	setRequestFactory(Service.GDataRequestFactory requestFactory) Sets the GDataRequestFactory currently associated with the service.
void	setStrictValidation(boolean strictValidation) Enables or disables strict validation.
void	setTimeouts(Service.GDataRequest request) Sets timeout value for GDataRequest.
void	startVersionScope()
<E extends IEntry> E	update(URL entryUrl, E entry) Updates an existing `IEntry` by writing it to the specified entry edit URL.
<E extends IEntry> E	update(URL entryUrl, E entry, String etag) Updates an existing `IEntry` by writing it to the specified entry edit URL.
void	useSsl() Sets the HttpGDataRequest.Factory associate with the service to use secure connections.
void	writeRequestData(Service.GDataRequest req, Service.ClientOutputProperties outProps, Object source) Writes the request body to the target service based upon requested output properties and the source object.
void	writeRequestData(Service.GDataRequest req, Object source) Writes the request body to the target service based upon the attributes of the request and the source object.

From class java.lang.Object

From interface com.google.gdata.client.AuthTokenFactory.TokenListener

Constants

public static final String APPS_PROP_GROUP_DESC

Constant Value: "description"

public static final String APPS_PROP_GROUP_EMAIL

Constant Value: "email"

public static final String APPS_PROP_GROUP_ID

Constant Value: "groupId"

public static final String APPS_PROP_GROUP_MEMBER_ID

Constant Value: "memberId"

public static final String APPS_PROP_GROUP_NAME

Constant Value: "groupName"

public static final String APPS_PROP_GROUP_PERMISSION

Constant Value: "emailPermission"

public static final String APPS_PROP_GROUP_ROLE

Constant Value: "role"

public static final String BASE_URL

Constant Value: "https://apps-apis.google.com/a/feeds/group/2.0/"

Fields

public final String baseDomainUrl

Public Constructors

public AppsGroupsService (String adminUser, String adminPassword, String domain, String applicationName)

Parameterized constructor to setup a Service object with user credentials.

Parameters

adminUser	Administrator username
adminPassword	Administrator password
domain	Domain being configured
applicationName	Application name consuming the API

Throws

AuthenticationException	If an authentication error occurs

public AppsGroupsService (String domain, String applicationName)

Parameterized constructor to setup a Service object which can be used to initialize the service without obtaining a token. The user should explicitly authorize the service by calling either setUserCredentials or setUserToken when using this constructor.

Parameters

domain	Domain being configured
applicationName	Application name consuming the API

Throws

AuthenticationException	If an authentication error occurs

Public Methods

public GenericEntry addMemberToGroup (String groupId, String memberName)

Adds a new member to the group. The member can either be a user/group in the domain or an arbitrary email address

Parameters

groupId	Unique ID of the group
memberName	Member username, group name or an email address

Returns

GenericEntry object with details of the newly added member

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericEntry addOwnerToGroup (String groupId, String ownerName)

Adds a new member as owner to the group. The owner can either be user or another group. This does not add the owner to the member feed. The owners can be retrieved from the owner feed.

Parameters

groupId	Unique ID of the group
ownerName	Member username or group name

Returns

GenericEntry object with details of the newly added owner

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericEntry createGroup (String groupId, String groupName, String groupDescription, String emailPermission)

Creates a new group in the domain.

Parameters

groupId	A unique identifier for the group
groupName	Name of the group
groupDescription	A description for the group
emailPermission	Email permission for user

Returns

GenericEntry object with details of the newly created group

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public void deleteGroup (String groupId)

Deletes a group from the domain. Deleting the group does not delete the user accounts for group members.

Parameters

groupId	Unique ID of the group

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public void deleteMemberFromGroup (String groupId, String memberName)

Removes member subscription to the group.

Parameters

groupId	Unique ID of the group
memberName	Member username or group name

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException

public boolean doesEntityExist (String feedUrlSuffix)

Checks for an available feed from a given Url. This method is used to discover members and owners

Parameters

feedUrlSuffix	The suffix of the feed URL to be investigated.

Returns

True if entity exists, false otherwise

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed getNextPage (Link atomLink)

Get the next page from the atom:next link

Parameters

atomLink	The feed link for next page

Returns

A GenericFeed of entries of next page from the atom:next link

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public boolean isMember (String groupId, String memberId)

Checks if an user/group is a member of the group specified.

Parameters

groupId	Group to be checked for
memberId	Username/Group

Returns

True, if given entity is a member

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public boolean isOwner (String groupId, String email)

Checks if an user is a owner of the group specified.

Parameters

groupId	Group ownership to be checked for
email	Owner's email

Returns

True, if given entity is an owner

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public void removeOwnerFromGroup (String email, String groupId)

Removes an owner from the group.

Parameters

email	Owner email address
groupId	Unique ID of the group

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retreiveGroupOwners (String groupId)

Retrieves all the owners of a given Group.

Parameters

groupId	The unique ID of the group

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retrieveAllGroups ()

Retrieves all groups in a domain as a GenericFeed. The client should follow the next feed link to retrieve subsequent pages.

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retrieveAllMembers (String groupId)

Retrieves all the members of a group as a GenericFeed.

Parameters

groupId	Unique ID of the group

Returns

List of GenericEntry objects containing member details

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException

public List<GenericEntry> retrieveAllPagesOfGroups ()

Retrieves all the pages of the groups feed. This method can be used by clients to retrieve a List of entries from all the pages of group feed.

Returns

List of GenericEntry instances

Throws

MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericEntry retrieveGroup (String groupId)

Retrieves the group details.

Parameters

groupId	Unique ID of the group

Returns

GenericEntry with the details of the group.

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retrieveGroups (String memberName, boolean directOnly)

Retrieves all groups of the given member.

Parameters

memberName	Member username
directOnly	If true, members with direct association only will be considered

Returns

List of GenericEntry with membership details.

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retrievePageOfGroups (Link next)

Retrieves next page of groups in a domain as a GenericFeed.

Parameters

next

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

public GenericFeed retrievePageOfMembers (Link next)

Retrieves next page of members of a group as a GenericFeed.

Parameters

next	Atom link to the next page

Returns

List of GenericEntry objects containing member details

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException

public GenericEntry updateGroup (String groupId, String groupName, String groupDescription, String emailPermission)

Updates the group properties. When a null or empty value is sent, the field is not updated the old value is preserved. Sending all null or empty values will not update the group and will fetch the original group entry.

Parameters

groupId	Unique ID of the group
groupName	Name of the group. A null or empty group name will preserve the old value
groupDescription	Description of the group. A null or empty value will preserve the old value
emailPermission	Email permissions associated with the group. A null or empty value will preserve the old value

Returns

GenericEntry object with updated details of the group

Throws

AppsForYourDomainException	If a Provisioning API error occurs
MalformedURLException	If a URL related error occurs
IOException	If a network I/O related error occurs
ServiceException	If the API service fails

Classes

AppsGroupsService

Class Overview

Summary

Constants

public static final String APPS_PROP_GROUP_DESC

public static final String APPS_PROP_GROUP_EMAIL

public static final String APPS_PROP_GROUP_ID

public static final String APPS_PROP_GROUP_MEMBER_ID

public static final String APPS_PROP_GROUP_NAME

public static final String APPS_PROP_GROUP_PERMISSION

public static final String APPS_PROP_GROUP_ROLE

public static final String BASE_URL

Fields

public final String baseDomainUrl

Public Constructors

public AppsGroupsService (String adminUser, String adminPassword, String domain, String applicationName)

Parameters

Throws

public AppsGroupsService (String domain, String applicationName)

Parameters

Throws

Public Methods

public GenericEntry addMemberToGroup (String groupId, String memberName)

Parameters

Returns

Throws

public GenericEntry addOwnerToGroup (String groupId, String ownerName)

Parameters

Returns

Throws

public GenericEntry createGroup (String groupId, String groupName, String groupDescription, String emailPermission)

Parameters

Returns

Throws

public void deleteGroup (String groupId)

Parameters

Throws

public void deleteMemberFromGroup (String groupId, String memberName)

Parameters

Throws

public boolean doesEntityExist (String feedUrlSuffix)

Parameters

Returns

Throws

public GenericFeed getNextPage (Link atomLink)

Parameters

Returns

Throws

public boolean isMember (String groupId, String memberId)

Parameters

Returns

Throws

public boolean isOwner (String groupId, String email)

Parameters

Returns

Throws

public void removeOwnerFromGroup (String email, String groupId)

Parameters

Throws

public GenericFeed retreiveGroupOwners (String groupId)

Parameters

Throws

public GenericFeed retrieveAllGroups ()

Throws

public GenericFeed retrieveAllMembers (String groupId)

Parameters

Returns

Throws

public List<GenericEntry> retrieveAllPagesOfGroups ()

Returns

Throws

public GenericEntry retrieveGroup (String groupId)

Parameters

Returns

Throws

public GenericFeed retrieveGroups (String memberName, boolean directOnly)

Parameters

Returns

Throws