Package org.odpi.openmetadata.accessservices.communityprofile.client

Class CommunityManagement

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

org.odpi.openmetadata.accessservices.communityprofile.client.CommunityManagement

All Implemented Interfaces:

CommunityManagementInterface, RelatedElementsManagementInterface

public class CommunityManagement
extends CommunityProfileBaseClient
implements CommunityManagementInterface

CommunityManagerClient supports the APIs to maintain communities and their related objects. It issues REST API calls to the Open Metadata Server running Community Profile OMAS that have a URL that begins: serverPlatformURLRoot/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}/communities

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

baseURLTemplatePrefix, openMetadataStoreClient, propertyHelper

Constructor Summary

Constructors

Constructor	Description
CommunityManagement(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
CommunityManagement(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
CommunityManagement(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
CommunityManagement(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
CommunityManagement(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearCommunityRole(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String personRoleGUID)	Remove a membership relationship between a community and a person role.
String	createCommunity(String userId, String externalSourceGUID, String externalSourceName, CommunityProperties communityProperties)	Create a new metadata element to represent a community.
String	createCommunityFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a community using an existing metadata element as a template.
List<CommunityElement>	findCommunities(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of metadata elements that contain the search string.
List<CommunityElement>	getCommunities(String userId, int startFrom, int pageSize)	Retrieve the list of all communities defined in open metadata.
List<CommunityElement>	getCommunitiesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of metadata elements with a matching qualified or display name.
CommunityElement	getCommunityByGUID(String userId, String communityGUID)	Retrieve the metadata element with the supplied unique identifier.
List<PersonRoleElement>	getRolesForCommunity(String userId, String communityGUID, int startFrom, int pageSize)	Return information about the person roles linked to a community.
void	removeCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID)	Remove the metadata element representing a community.
void	setupCommunityRole(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, CommunityMembershipProperties membershipProperties, String personRoleGUID)	Create a membership relationship between a community and a person role to show that anyone appointed to the role is a member of the community.
void	updateCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, boolean isMergeUpdate, CommunityProperties communityProperties)	Update the metadata element representing a community.

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

clearAssignmentScope, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getMoreInformation, getResourceList, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupMoreInformation, setupResource, setupStakeholder, updateRelationship

Methods inherited from class java.lang.Object

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

Constructor Details

CommunityManagement

public CommunityManagement(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                    throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CommunityManagement

public CommunityManagement(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                    throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CommunityManagement

public CommunityManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                    throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CommunityManagement

public CommunityManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                    throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

CommunityManagement

public CommunityManagement(String serverName,
 String serverPlatformURLRoot,
 CommunityProfileRESTClient restClient,
 int maxPageSize)
                    throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createCommunity

public String createCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 CommunityProperties communityProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a community.

Specified by:

createCommunity in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

communityProperties - properties about the community to store. The qualifiedName property must be supplied and must be unique.

Returns:

unique identifier of the new community

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createCommunityFromTemplate

public String createCommunityFromTemplate(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String templateGUID,
 TemplateProperties templateProperties)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a community using an existing metadata element as a template.

Specified by:

createCommunityFromTemplate in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new community

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateCommunity

public void updateCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 boolean isMergeUpdate,
 CommunityProperties communityProperties)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a community.

Specified by:

updateCommunity in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

communityGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

communityProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupCommunityRole

public void setupCommunityRole(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 CommunityMembershipProperties membershipProperties,
 String personRoleGUID)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a membership relationship between a community and a person role to show that anyone appointed to the role is a member of the community.

Specified by:

setupCommunityRole in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

communityGUID - unique identifier of the community

membershipProperties - describes the permissions that the role has in the community

personRoleGUID - unique identifier of the person role

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearCommunityRole

public void clearCommunityRole(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID,
 String personRoleGUID)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a membership relationship between a community and a person role.

Specified by:

clearCommunityRole in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

communityGUID - unique identifier of the community

personRoleGUID - unique identifier of the person role

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeCommunity

public void removeCommunity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String communityGUID)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a community.

Specified by:

removeCommunity in interface CommunityManagementInterface

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

communityGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findCommunities

public List<CommunityElement> findCommunities(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findCommunities in interface CommunityManagementInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCommunitiesByName

public List<CommunityElement> getCommunitiesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getCommunitiesByName in interface CommunityManagementInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCommunities

public List<CommunityElement> getCommunities(String userId,
 int startFrom,
 int pageSize)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of all communities defined in open metadata.

Specified by:

getCommunities in interface CommunityManagementInterface

Parameters:

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getRolesForCommunity

public List<PersonRoleElement> getRolesForCommunity(String userId,
 String communityGUID,
 int startFrom,
 int pageSize)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the person roles linked to a community.

Specified by:

getRolesForCommunity in interface CommunityManagementInterface

Parameters:

userId - calling user

communityGUID - unique identifier for the community

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCommunityByGUID

public CommunityElement getCommunityByGUID(String userId,
 String communityGUID)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the metadata element with the supplied unique identifier.

Specified by:

getCommunityByGUID in interface CommunityManagementInterface

Parameters:

userId - calling user

communityGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)