Class SolutionArchitectRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.solutionarchitect.server.SolutionArchitectRESTServices

public class SolutionArchitectRESTServices extends TokenController
The SolutionArchitectRESTServices provides the server-side implementation of the Solution Architect Open Metadata View Service (OMVS). This interface provides access to information supply chains, solution blueprints, solution components and solution roles.
  • Constructor Details

    • SolutionArchitectRESTServices

      public SolutionArchitectRESTServices()
      Default constructor
  • Method Details

    • createInformationSupplyChain

      public GUIDResponse createInformationSupplyChain(String serverName, NewInformationSupplyChainRequestBody requestBody)
      Create an information supply chain.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the information supply chain.
      Returns:
      unique identifier of the newly created element 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.
    • createInformationSupplyChainFromTemplate

      public GUIDResponse createInformationSupplyChainFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent an information supply chain using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)
    • updateInformationSupplyChain

      public VoidResponse updateInformationSupplyChain(String serverName, String informationSupplyChainGUID, boolean replaceAllProperties, UpdateInformationSupplyChainRequestBody requestBody)
      Update the properties of an information supply chain.
      Parameters:
      serverName - name of called server.
      informationSupplyChainGUID - unique identifier of the information supply chain (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      Returns:
      void or 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.
    • createInformationSupplyChainSegment

      public GUIDResponse createInformationSupplyChainSegment(String serverName, String informationSupplyChainGUID, InformationSupplyChainSegmentRequestBody requestBody)
      Create an information supply chain segment.
      Parameters:
      serverName - name of called server.
      informationSupplyChainGUID - unique identifier of optional parent information supply chain
      requestBody - properties for the information supply chain.
      Returns:
      unique identifier of the newly created element 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.
    • updateInformationSupplyChainSegment

      public VoidResponse updateInformationSupplyChainSegment(String serverName, String segmentGUID, boolean replaceAllProperties, InformationSupplyChainSegmentRequestBody requestBody)
      Update the properties of an information supply chain segment.
      Parameters:
      serverName - name of called server.
      segmentGUID - unique identifier of the information supply chain segment (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      Returns:
      void or 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.
    • linkSegments

      public VoidResponse linkSegments(String serverName, String segment1GUID, String segment2GUID, InformationSupplyChainLinkRequestBody requestBody)
      Connect two information supply chain segments.
      Parameters:
      serverName - name of called server
      segment1GUID - unique identifier of the first segment
      segment2GUID - unique identifier of the second segment
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • detachSegments

      public VoidResponse detachSegments(String serverName, String segment1GUID, String segment2GUID, MetadataSourceRequestBody requestBody)
      Detach two information supply chain segments from one another.
      Parameters:
      serverName - name of called server
      segment1GUID - unique identifier of the first segment
      segment2GUID - unique identifier of the second segment
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • deleteInformationSupplyChainSegment

      public VoidResponse deleteInformationSupplyChainSegment(String serverName, String segmentGUID, MetadataSourceRequestBody requestBody)
      Delete an information supply chain segment.
      Parameters:
      serverName - name of called server
      segmentGUID - unique identifier of the segment
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • deleteInformationSupplyChain

      public VoidResponse deleteInformationSupplyChain(String serverName, String informationSupplyChainGUID, MetadataSourceRequestBody requestBody)
      Delete an information supply chain.
      Parameters:
      serverName - name of called server
      informationSupplyChainGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
    • getInformationSupplyChainsByName

      public InformationSupplyChainsResponse getInformationSupplyChainsByName(String serverName, boolean addImplementation, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • findInformationSupplyChains

      public InformationSupplyChainsResponse findInformationSupplyChains(String serverName, boolean addImplementation, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • getInformationSupplyChainByGUID

      public InformationSupplyChainResponse getInformationSupplyChainByGUID(String serverName, String informationSupplyChainGUID, boolean addImplementation, AnyTimeRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      informationSupplyChainGUID - unique identifier of the required element
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • findSolutionBlueprints

      public SolutionBlueprintsResponse findSolutionBlueprints(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of solution blueprint metadata elements that contain the search string. The returned blueprints include a list of the components that are associated with it.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • findSolutionRoles

      public SolutionRolesResponse findSolutionRoles(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of actor roles metadata elements that contain the search string and show which solution components (if any) are attached to it.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • findSolutionComponents

      public SolutionComponentsResponse findSolutionComponents(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of solution component metadata elements that contain the search string. The solutions components returned include information about the consumers, actors and other solution components that are associated with them.
      Parameters:
      serverName - name of the service to route the request to
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)
    • getSolutionComponentImplementations

      public RelatedMetadataElementsResponse getSolutionComponentImplementations(String serverName, String solutionComponentGUID, int startFrom, int pageSize, ResultsRequestBody requestBody)
      Retrieve the list of metadata elements that are associated with the solution component via the ImplementedBy relationship.
      Parameters:
      serverName - name of the service to route the request to
      solutionComponentGUID - unique identifier of the solution component to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)