Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface ITProfileManagerInterface

All Known Implementing Classes:

ITProfileManagerClient

public interface ITProfileManagerInterface

ITProfileManagerInterface defines the client interface for setting up the profile and userId for a piece of IT infrastructure.

Method Summary

Modifier and Type	Method	Description
String	addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, ContactMethodProperties properties)	Add a new contact method to the profile.
void	addIdentityToProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, ProfileIdentityProperties properties)	Link a user identity to a profile.
String	createITProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itUserId, ITProfileProperties properties)	Create a definition of an IT profile.
String	createUserIdentity(String userId, String externalSourceGUID, String externalSourceName, UserIdentityProperties newIdentity)	Create a UserIdentity.
void	deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String contactMethodGUID)	Remove an obsolete contact method from the profile.
void	deleteITProfile(String userId, String itProfileGUID, String externalSourceGUID, String externalSourceName)	Remove the definition of an IT profile.
void	deleteUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID)	Remove a user identity object.
List<ITProfileElement>	findITProfile(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of matching profiles for the search string.
List<UserIdentityElement>	findUserIdentities(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements that contain the search string.
ITProfileElement	getITProfileByGUID(String userId, String itProfileGUID)	Return information about a specific IT profile.
List<ITProfileElement>	getITProfileByName(String userId, String name, int startFrom, int pageSize)	Return information about a named IT profile.
ITProfileElement	getITProfileByUserId(String userId, String itProfileUserId)	Return information about a specific IT profile.
List<UserIdentityElement>	getUserIdentitiesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of user identity metadata elements with a matching qualified name.
UserIdentityElement	getUserIdentityByGUID(String userId, String userIdentityGUID)	Retrieve the userIdentity metadata element with the supplied unique identifier.
void	linkITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)	Link a piece of infrastructure to an IT profile.
void	removeIdentityFromProfile(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID)	Unlink a user identity from a profile.
void	unlinkITInfrastructureFromProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveTime)	Remove the link between a piece of infrastructure to an IT profile.
void	updateITInfrastructureToProfile(String userId, String externalSourceGUID, String externalSourceName, String itInfrastructureGUID, String itProfileGUID, Date effectiveFrom, Date effectiveTo)	Update the effectivity dates of a link from a piece of infrastructure to an IT profile.
void	updateITProfile(String userId, String externalSourceGUID, String externalSourceName, String itProfileGUID, boolean isMergeUpdate, ITProfileProperties properties)	Update the definition of an IT profile.
void	updateProfileIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, String profileGUID, boolean isMergeUpdate, ProfileIdentityProperties properties)	Update the properties of the relationship between a user identity and profile.
void	updateUserIdentity(String userId, String externalSourceGUID, String externalSourceName, String userIdentityGUID, boolean isMergeUpdate, UserIdentityProperties properties)	Update a UserIdentity.

Method Details

createITProfile

String createITProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itInfrastructureGUID,
 String itUserId,
 ITProfileProperties properties)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of an IT profile. If the itInfrastructureGUID is provided, it is connected to the infrastructure element that the profile describes using the ITInfrastructureProfile relationship. If the itUserId is specified, a UserIdentity for that userId is found/created and connected to the new IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itInfrastructureGUID - unique identifier of the piece of IT infrastructure that is described by the new IT profile.

itUserId - user Id used by the IT Infrastructure

properties - properties for a IT profile

Returns:

unique identifier of IT profile

Throws:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateITProfile

void updateITProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itProfileGUID,
 boolean isMergeUpdate,
 ITProfileProperties properties)
              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the definition of an IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itProfileGUID - unique identifier of IT profile

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteITProfile

void deleteITProfile(String userId,
 String itProfileGUID,
 String externalSourceGUID,
 String externalSourceName)
              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the definition of an IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itProfileGUID - unique identifier of IT profile

Throws:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addContactMethod

String addContactMethod(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itProfileGUID,
 ContactMethodProperties properties)
                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Add a new contact method to the profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itProfileGUID - identifier of the profile to update.

properties - properties of contact method.

Returns:

unique identifier (guid) for the new contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteContactMethod

void deleteContactMethod(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String contactMethodGUID)
                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove an obsolete contact method from the profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

contactMethodGUID - unique identifier (guid) for the obsolete contact method.

Throws:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

linkITInfrastructureToProfile

void linkITInfrastructureToProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itInfrastructureGUID,
 String itProfileGUID,
 Date effectiveFrom,
 Date effectiveTo)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link a piece of infrastructure to an IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itInfrastructureGUID - unique identifier of the IT Infrastructure element

itProfileGUID - unique identifier of the IT profile

effectiveFrom - start date for the relationship

effectiveTo - end date for the relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateITInfrastructureToProfile

void updateITInfrastructureToProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itInfrastructureGUID,
 String itProfileGUID,
 Date effectiveFrom,
 Date effectiveTo)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the effectivity dates of a link from a piece of infrastructure to an IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itInfrastructureGUID - unique identifier of the IT Infrastructure element

itProfileGUID - unique identifier of the IT profile

effectiveFrom - start date for the relationship

effectiveTo - end date for the relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkITInfrastructureFromProfile

void unlinkITInfrastructureFromProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String itInfrastructureGUID,
 String itProfileGUID,
 Date effectiveTime)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a piece of infrastructure to an IT profile.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

itInfrastructureGUID - unique identifier of the IT Infrastructure element

itProfileGUID - unique identifier of the IT profile

effectiveTime - time that the relationship is active - null for any time

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getITProfileByGUID

ITProfileElement getITProfileByGUID(String userId,
 String itProfileGUID)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific IT profile.

Parameters:

userId - calling user

itProfileGUID - unique identifier for the IT profile

Returns:

properties of the IT profile

Throws:

InvalidParameterException - itProfileGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getITProfileByUserId

ITProfileElement getITProfileByUserId(String userId,
 String itProfileUserId)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific IT profile.

Parameters:

userId - calling user

itProfileUserId - unique identifier for the IT profile

Returns:

properties of the IT profile

Throws:

InvalidParameterException - itProfileUserId or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getITProfileByName

List<ITProfileElement> getITProfileByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a named IT profile.

Parameters:

userId - calling user

name - unique name for the IT profile

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

pageSize - maximum number of elements to return.

Returns:

list of matching IT profiles (hopefully only one)

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findITProfile

List<ITProfileElement> findITProfile(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the list of matching profiles for the search string.

Parameters:

userId - the name of the calling user.

searchString - RegEx string to search for

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

pageSize - maximum number of elements to return.

Returns:

list of matching IT profiles

Throws:

InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

createUserIdentity

String createUserIdentity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 UserIdentityProperties newIdentity)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a UserIdentity. This is not connected to a profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

newIdentity - properties for the new userIdentity.

Returns:

unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateUserIdentity

void updateUserIdentity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String userIdentityGUID,
 boolean isMergeUpdate,
 UserIdentityProperties properties)
                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update a UserIdentity.

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

properties - updated properties for the new userIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteUserIdentity

void deleteUserIdentity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String userIdentityGUID)
                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove a user identity object.

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addIdentityToProfile

void addIdentityToProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String userIdentityGUID,
 String profileGUID,
 ProfileIdentityProperties properties)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Link a user identity to a profile.

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - additional userId for the profile

profileGUID - the profile to add the identity to

properties - the properties that describe how the owner of the profile uses the user identity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateProfileIdentity

void updateProfileIdentity(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String userIdentityGUID,
 String profileGUID,
 boolean isMergeUpdate,
 ProfileIdentityProperties properties)
                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of the relationship between a user identity and profile.

Parameters:

userId - the name of the calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - additional userId for the profile

profileGUID - the profile to add the identity to

isMergeUpdate - should the supplied properties be overlaid on the existing properties (true) or replace them (false

properties - the properties that describe how the owner of the profile uses the user identity

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeIdentityFromProfile

void removeIdentityFromProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String userIdentityGUID,
 String profileGUID)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Unlink a user identity from a profile.

Parameters:

userId - the name of the calling user.

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

userIdentityGUID - unique identifier of the UserIdentity

profileGUID - the profile to add the identity to.

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

findUserIdentities

List<UserIdentityElement> findUserIdentities(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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)

getUserIdentitiesByName

List<UserIdentityElement> getUserIdentitiesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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)

getUserIdentityByGUID

UserIdentityElement getUserIdentityByGUID(String userId,
 String userIdentityGUID)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the userIdentity metadata element with the supplied unique identifier.

Parameters:

userId - calling user

userIdentityGUID - unique identifier of the requested metadata element

Returns:

matching 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)