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

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

      • createITProfile

        java.lang.String createITProfile​(java.lang.String userId,
                                         java.lang.String externalSourceGUID,
                                         java.lang.String externalSourceName,
                                         java.lang.String itInfrastructureGUID,
                                         java.lang.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​(java.lang.String userId,
                             java.lang.String externalSourceGUID,
                             java.lang.String externalSourceName,
                             java.lang.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​(java.lang.String userId,
                             java.lang.String itProfileGUID,
                             java.lang.String externalSourceGUID,
                             java.lang.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

        java.lang.String addContactMethod​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.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​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.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​(java.lang.String userId,
                                           java.lang.String externalSourceGUID,
                                           java.lang.String externalSourceName,
                                           java.lang.String itInfrastructureGUID,
                                           java.lang.String itProfileGUID,
                                           java.util.Date effectiveFrom,
                                           java.util.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​(java.lang.String userId,
                                             java.lang.String externalSourceGUID,
                                             java.lang.String externalSourceName,
                                             java.lang.String itInfrastructureGUID,
                                             java.lang.String itProfileGUID,
                                             java.util.Date effectiveFrom,
                                             java.util.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​(java.lang.String userId,
                                               java.lang.String externalSourceGUID,
                                               java.lang.String externalSourceName,
                                               java.lang.String itInfrastructureGUID,
                                               java.lang.String itProfileGUID,
                                               java.util.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
      • createUserIdentity

        java.lang.String createUserIdentity​(java.lang.String userId,
                                            java.lang.String externalSourceGUID,
                                            java.lang.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​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.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​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.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​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String userIdentityGUID,
                                  java.lang.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​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String userIdentityGUID,
                                   java.lang.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​(java.lang.String userId,
                                       java.lang.String externalSourceGUID,
                                       java.lang.String externalSourceName,
                                       java.lang.String userIdentityGUID,
                                       java.lang.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.