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}
-
-
Constructor Summary
Constructors Constructor Description CommunityManagement(String serverName, String serverPlatformURLRoot)Create a new client with no authentication embedded in the HTTP request.CommunityManagement(String serverName, String serverPlatformURLRoot, String userId, String password)Create a new client that passes userId and password in each HTTP request.CommunityManagement(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)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)Create a new client with no authentication embedded in the HTTP request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearCommunityRole(String userId, String externalSourceGUID, String externalSourceName, String communityGUID, String personRoleGUID)Remove a membership relationship between a community and a person role.StringcreateCommunity(String userId, String externalSourceGUID, String externalSourceName, CommunityProperties communityProperties)Create a new metadata element to represent a community.StringcreateCommunityFromTemplate(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.CommunityElementgetCommunityByGUID(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.voidremoveCommunity(String userId, String externalSourceGUID, String externalSourceName, String communityGUID)Remove the metadata element representing a community.voidsetupCommunityRole(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.voidupdateCommunity(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
-
-
-
-
Constructor Detail
-
CommunityManagement
public CommunityManagement(String serverName, String serverPlatformURLRoot, AuditLog auditLog) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName- name of the server to connect toserverPlatformURLRoot- the network address of the server running the OMAS REST serversauditLog- logging destination- Throws:
InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
CommunityManagement
public CommunityManagement(String serverName, String serverPlatformURLRoot) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName- name of the server to connect toserverPlatformURLRoot- the network address of the server running the OMAS REST servers- 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) 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversuserId- caller's userId embedded in all HTTP requestspassword- caller's userId embedded in all HTTP requests- 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) 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversuserId- caller's userId embedded in all HTTP requestspassword- caller's userId embedded in all HTTP requestsauditLog- logging destination- 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 toserverPlatformURLRoot- the network address of the server running the OMAS REST serversrestClient- client that issues the REST API callsmaxPageSize- 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 Detail
-
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:
createCommunityin interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callercommunityProperties- 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 invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
createCommunityFromTemplatein interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callertemplateGUID- unique identifier of the metadata element to copytemplateProperties- properties that override the template- Returns:
- unique identifier of the new community
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
updateCommunityin interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callercommunityGUID- unique identifier of the metadata element to updateisMergeUpdate- 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 invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
setupCommunityRolein interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callercommunityGUID- unique identifier of the communitymembershipProperties- describes the permissions that the role has in the communitypersonRoleGUID- unique identifier of the person role- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
clearCommunityRolein interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callercommunityGUID- unique identifier of the communitypersonRoleGUID- unique identifier of the person role- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
removeCommunityin interfaceCommunityManagementInterface- Parameters:
userId- calling userexternalSourceGUID- unique identifier of software capability representing the callerexternalSourceName- unique name of software capability representing the callercommunityGUID- unique identifier of the metadata element to remove- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
findCommunitiesin interfaceCommunityManagementInterface- Parameters:
userId- calling usersearchString- string to find in the propertiesstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
getCommunitiesByNamein interfaceCommunityManagementInterface- Parameters:
userId- calling username- name to search forstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
getCommunitiesin interfaceCommunityManagementInterface- Parameters:
userId- calling userstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- 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:
getRolesForCommunityin interfaceCommunityManagementInterface- Parameters:
userId- calling usercommunityGUID- unique identifier for the communitystartFrom- 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 nullPropertyServerException- problem accessing property serverUserNotAuthorizedException- 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:
getCommunityByGUIDin interfaceCommunityManagementInterface- Parameters:
userId- calling usercommunityGUID- unique identifier of the requested metadata element- Returns:
- requested metadata element
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
-