org.osiam.client.OsiamGroupService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connector4java Show documentation
Show all versions of connector4java Show documentation
Native Java API to connect to the REST based OSIAM services
/*
* Copyright (C) 2013 tarent AG
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.osiam.client;
import java.util.List;
import org.osiam.client.oauth.AccessToken;
import org.osiam.client.query.Query;
import org.osiam.client.update.UpdateGroup;
import org.osiam.resources.scim.Group;
import org.osiam.resources.scim.SCIMSearchResult;
/**
* OsiamGroupService provides all methods necessary to manipulate the {@link Group} resources registered in the
* given OSIAM installation. For the construction of an instance please use the {@link OsiamGroupService.Builder}
*/
public final class OsiamGroupService extends AbstractOsiamService { // NOSONAR - Builder constructs instances of this class
/**
* The private constructor for the OsiamGroupService. Please use the {@link OsiamGroupService.Builder}
* to construct one.
*
* @param builder The Builder to build the OsiamGroupService from
*/
private OsiamGroupService(Builder builder) {
super(builder);
}
/**
* Retrieve a single Group with the given id. If no group with the given id can be found a
* {@link NoResultException} is thrown.
*
* @param id the id of the wanted group
* @param accessToken the access token from OSIAM for the current session.
* @return the group with the given id.
* @throws org.osiam.client.exception.UnauthorizedException
* if the request could not be authorized.
* @throws NoResultException
* if no user with the given id can be found
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
*/
public Group getGroup(String id, AccessToken accessToken) {
return getResource(id, accessToken);
}
/**
* Retrieve a list of the of all {@link Group} resources saved in the OSIAM service.
* If you need to have all Group but the number is very big, this method can be slow.
* In this case you can also use Query.Builder with no filter to split the number of Groups returned
*
* @param accessToken the OSIAM access token for the current session
* @return a list of all groups
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
*/
public List getAllGroups(AccessToken accessToken) {
return getAllResources(accessToken);
}
/**
* Search for existing groups by a given search string. For more detailed information about the possible logical
* operators and usable fields please have a look into the wiki.
*
* @param queryString a string containing the needed search where statement
* @param accessToken the OSIAM access token from for the current session
* @return a QueryResult containing a list of all found Groups
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
* @see https://github.com/osiam/connector4java/wiki/Working-with-groups#search-for-groups
*/
public SCIMSearchResult searchGroups(String queryString, AccessToken accessToken) {
return searchResources(queryString, accessToken);
}
/**
* Search for existing groups by a given @{link Query}. For more detailed information about the possible logical
* operators and usable fields please have a look into the wiki.
*
* @param query containing the needed search where statement
* @param accessToken the OSIAM access token from for the current session
* @return a QueryResult containing a list of all found Groups
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
* @see https://github.com/osiam/connector4java/wiki/Working-with-groups#search-for-groups
*/
public SCIMSearchResult searchGroups(Query query, AccessToken accessToken) {
return searchResources(query, accessToken);
}
/**
* delete the given {@link Group} at the OSIAM DB.
*
* @param id id of the Group to be deleted
* @param accessToken the OSIAM access token from for the current session
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws NoResultException
* if no group with the given id can be found
* @throws ConflictException
* if the Group could not be deleted
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
*/
public void deleteGroup(String id, AccessToken accessToken) {
deleteResource(id, accessToken);
}
/**
* saves the given {@link Group} to the OSIAM DB.
*
* @param group group to be saved
* @param accessToken the OSIAM access token from for the current session
* @return the same group Object like the given but with filled metadata and a new valid id
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws ConflictException
* if the Group could not be created
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
*/
public Group createGroup(Group group, AccessToken accessToken) {
return createResource(group, accessToken);
}
/**
* update the group of the given id with the values given in the Group Object.
* For more detailed information how to set new field. Update Fields or to delete Fields please look in the wiki
*
* @param id id of the Group to be updated
* @param updateGroup all Fields that need to be updated
* @param accessToken the OSIAM access token from for the current session
* @return the updated group Object
* @throws UnauthorizedException
* if the request could not be authorized.
* @throws ConflictException
* if the Group could not be updated
* @throws NotFoundException
* if no group with the given id can be found
* @throws ForbiddenException
* if the scope doesn't allow this request
* @throws ConnectionInitializationException
* if the connection to the given OSIAM service could not be initialized
* @see https://github.com/osiam/connector4java/wiki/Working-with-groups
*/
public Group updateGroup(String id, UpdateGroup updateGroup, AccessToken accessToken) {
return updateResource(id, updateGroup.getScimConformUpdateGroup(), accessToken);
}
/**
* Updates only the given fields of the Group and leaves the omitted fields untouched.
* @param group A Group object with the values to update filled in
* @param accessToken A valid AccessToken
* @return The updated Group as seen by the server
*/
public Group updateGroup(String id, Group group, AccessToken accessToken) {
return updateResource(id, group, accessToken);
}
/**
* Replaces the Group with the given Group. Any field set in the original Group but not in the
* given Group will be removed. Including memberships.
* @param group A Group object to replace the given Group with
* @param accessToken A valid AccessToken
* @return The replaced Group as seen by the server
*/
public Group replaceGroup(String id, Group group, AccessToken accessToken){
return replaceResource(id, group, accessToken);
}
/**
* The Builder is used to construct instances of the {@link OsiamGroupService}
*/
public static class Builder extends AbstractOsiamService.Builder {
/**
* Set up the Builder for the construction of an {@link OsiamGroupService} instance for the OSIAM service at
* the given endpoint
*
* @param endpoint The URL at which the OSIAM server lives.
*/
public Builder(String endpoint) {
super(endpoint);
}
/**
* constructs a OsiamGroupService with the given values
*
* @return a valid OsiamGroupService
*/
public OsiamGroupService build() {
return new OsiamGroupService(this);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy