Class ValidValuesAssetOwner

    • Constructor Detail

      • ValidValuesAssetOwner

        public ValidValuesAssetOwner​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     AuditLog auditLog)
                              throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request and an audit log.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ValidValuesAssetOwner

        public ValidValuesAssetOwner​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot)
                              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 servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ValidValuesAssetOwner

        public ValidValuesAssetOwner​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     java.lang.String userId,
                                     java.lang.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. There is also an audit log destination.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • ValidValuesAssetOwner

        public ValidValuesAssetOwner​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     java.lang.String userId,
                                     java.lang.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 to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - 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.
      • ValidValuesAssetOwner

        public ValidValuesAssetOwner​(java.lang.String serverName,
                                     java.lang.String serverPlatformURLRoot,
                                     AssetOwnerRESTClient restClient,
                                     int maxPageSize,
                                     AuditLog auditLog)
                              throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • createValidValueSet

        public java.lang.String createValidValueSet​(java.lang.String userId,
                                                    java.lang.String qualifiedName,
                                                    java.lang.String displayName,
                                                    java.lang.String description,
                                                    java.lang.String usage,
                                                    java.lang.String scope,
                                                    java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                    java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Create a new valid value set. This just creates the Set itself. Members are added either as they are created, or they can be attached to a set after they are created.
        Specified by:
        createValidValueSet in interface AssetOnboardingValidValues
        Parameters:
        userId - calling user.
        qualifiedName - unique name.
        displayName - displayable descriptive name.
        description - further information.
        usage - how/when should this set be used.
        scope - what is the scope of this set's values.
        additionalProperties - additional properties for this set.
        extendedProperties - properties that need to be populated into a subtype.
        Returns:
        unique identifier for the new set
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • createValidValueDefinition

        public java.lang.String createValidValueDefinition​(java.lang.String userId,
                                                           java.lang.String setGUID,
                                                           boolean isDefaultValue,
                                                           java.lang.String qualifiedName,
                                                           java.lang.String displayName,
                                                           java.lang.String description,
                                                           java.lang.String usage,
                                                           java.lang.String scope,
                                                           java.lang.String preferredValue,
                                                           java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                           java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Create a new valid value definition.
        Specified by:
        createValidValueDefinition in interface AssetOnboardingValidValues
        Parameters:
        userId - calling user.
        setGUID - unique identifier of the set to attach this to.
        isDefaultValue - is this the default value for the set?
        qualifiedName - unique name.
        displayName - displayable descriptive name.
        description - further information.
        usage - how/when should this value be used.
        preferredValue - the value that should be used in an implementation if possible.
        additionalProperties - additional properties for this definition.
        extendedProperties - properties that need to be populated into a subtype.
        scope - what is the scope of the values.
        Returns:
        unique identifier for the new definition
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.
      • updateValidValue

        public void updateValidValue​(java.lang.String userId,
                                     java.lang.String validValueGUID,
                                     java.lang.String qualifiedName,
                                     java.lang.String displayName,
                                     java.lang.String description,
                                     java.lang.String usage,
                                     java.lang.String scope,
                                     java.lang.String preferredValue,
                                     boolean isDeprecated,
                                     java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                     java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the properties of the valid value. All properties are updated. If only changing some if the properties, retrieve the current values from the repository and pass existing values back on this call if they are not to change.
        Specified by:
        updateValidValue in interface AssetOnboardingValidValues
        Parameters:
        userId - calling user.
        validValueGUID - unique identifier of the valid value.
        qualifiedName - unique name.
        displayName - displayable descriptive name.
        description - further information.
        usage - how/when should this value be used.
        scope - what is the scope of the values.
        preferredValue - the value that should be used in an implementation if possible.
        isDeprecated - is this value deprecated?
        additionalProperties - additional properties for this valid value.
        extendedProperties - properties that need to be populated into a subtype.
        Throws:
        InvalidParameterException - one of the parameters is invalid.
        UserNotAuthorizedException - the user is not authorized to make this request.
        PropertyServerException - the repository is not available or not working properly.