Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client

Class GlossaryAuthorViewRestClient

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.GlossaryAuthorViewRestClient
public class GlossaryAuthorViewRestClient extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryAuthorViewRestClient(String serverName, String serverPlatformURLRoot)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder
    createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
    org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder
    createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
     
    org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder
    createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
    Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    delRESTCall(String userId, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, String methodName, String urnTemplate, String guid)
    Issue a DEL REST call that returns a response object.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    findRESTCall(String userId, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)
    Issue a GET REST call that does a find and returns results in a Generic Response.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    findRESTCallById(String userId, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall, String guid)
    Issue a GET REST call that does a find and returns results in a Generic Response.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    getByGUIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate)
    Issue a GET REST call that returns a response object by guid.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate)
    Issue a GET REST call that returns a response object by guid.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Integer maximumPageSizeOnRestCall, Map<String,String> params)
    Issue a GET REST call that returns a response object by guid.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Integer maximumPageSizeOnRestCall, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams)
    Issue a GET REST call that returns a response object by guid.
    org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse
    getConfigRESTCall(String userId, String guid, String methodName, Class<org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse> type, String urnTemplate)
    Issue a GET REST call that returns a Config object by guid.
    org.odpi.openmetadata.adminservices.rest.ViewServicesResponse
    getViewConfigRESTCall(String userId, String methodName, Class<org.odpi.openmetadata.adminservices.rest.ViewServicesResponse> type, String urnTemplate)
    Issue a GET REST call that returns a View Config object by guid.
    org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse
    getViewServiceConfigRESTCall(String userId, String guid, String methodName, Class<org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse> type, String urnTemplate)
    Issue a GET REST call that returns a View Config object by guid.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    postRESTCall(String userId, String methodName, String urlTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String guid)
    Issue a POST REST call that returns a response object.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    postRESTCall(String userId, String create, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, T t)
    Issue a POST REST call that returns a response object.
    org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>>
    postRESTCallArr(String userId, String methodName, String urlTemplate, String guid, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray)
    Issue a POST REST call that returns a response array.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    putRESTCall(String userId, String guid, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category, Object... params)
    Issue a PUT REST call that returns a response object.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    putRESTCall(String userId, String guid, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, Object... params)
    Issue a PUT REST call that returns a response object.
    <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>
    putRESTCall(String userId, String guid, String methodName, String urlTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, T t)
    Issue a PUT REST call that returns a response object.

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

    callBooleanGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

    callPostRESTCallNoParams

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GlossaryAuthorViewRestClient

      public GlossaryAuthorViewRestClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

  • Method Details

    • getByIdRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a response object by guid.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getByGUIdRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> getByGUIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a response object by guid.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the received object
      methodName - name of the method being called.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • postRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> postRESTCall(String userId, String methodName, String urlTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a POST REST call that returns a response object.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      methodName - name of the method being called.
      urlTemplate - template of the URN for the REST API call with place-holders for the parameters.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      guid - unique identifier of the object
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • postRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> postRESTCall(String userId, String create, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, T t) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a POST REST call that returns a response object. The object to be created is passed.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      create - name of the action/method been called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      t - object to be creates
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • postRESTCallArr

      public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>> postRESTCallArr(String userId, String methodName, String urlTemplate, String guid, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term[] termArray) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a POST REST call that returns a response array. The array of objects to be created is passed.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      methodName - name of the method being called.
      urlTemplate - template of the URN for the REST API call with place-holders for the parameters.
      guid - unique identifier of the glossary object
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      termArray - Array of terms to be creates
      Returns:
      Array of type SubjectAreaOMASAPIResponse
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • putRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> putRESTCall(String userId, String guid, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a PUT REST call that returns a response object. The object to be updated is passed.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      glossary - Glossary to be creates
      params - additional parameters to be passed
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • putRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> putRESTCall(String userId, String guid, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category category, Object... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a PUT REST call that returns a response object. The object to be updated is passed.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      category - Category to be creates
      params - additional parameters to be passed
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • putRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> putRESTCall(String userId, String guid, String methodName, String urlTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, T t) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a PUT REST call that returns a response object. The object to be updated is passed.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      urlTemplate - template of the URN for the REST API call with place-holders for the parameters.
      parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      t - type of object to be creates
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • delRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> delRESTCall(String userId, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> parameterizedType, String methodName, String urnTemplate, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Issue a DEL REST call that returns a response object.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      parameterizedType - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      methodName - name of the method being called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      guid - unique identifier of the object
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

    • createFindQuery

      public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
      Parameters:
      methodName - name of the method being called.
      findRequest - FindRequest
      Returns:
      query
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • createFindQuery

      public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

    • createFindQuery

      public org.odpi.openmetadata.accessservices.subjectarea.utils.QueryBuilder createFindQuery(String methodName, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Method for constructing a query (https://en.wikipedia.org/wiki/Query_string) using the information described in the findRequest page size and startingFrom need to set by the caller.
      Parameters:
      methodName - name of the method being called.
      findRequest - FindRequest
      queryParams - query parameters
      Returns:
      query
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • findRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> findRESTCall(String userId, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that does a find and returns results in a Generic Response.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      methodName - name of the method being called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      findRequest - FindRequest
      exactValue - boolean to determine search parameters should return exact values
      ignoreCase - boolean to determine search parameters should ignore case for teh search criteris
      maximumPageSizeOnRestCall - Page size for results
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • findRESTCallById

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> findRESTCallById(String userId, String methodName, String urnTemplate, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that does a find and returns results in a Generic Response.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      methodName - name of the method being called.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      findRequest - FindRequest
      exactValue - boolean to determine search parameters should return exact values
      ignoreCase - boolean to determine search parameters should ignore case for teh search criteris
      maximumPageSizeOnRestCall - Page size for results
      guid - Object guid
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getByIdRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Integer maximumPageSizeOnRestCall, Map<String,String> params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a response object by guid.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      findRequest - FindRequest
      maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
      params - additional parameters to be passed
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getByIdRESTCall

      public <T> org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T> getByIdRESTCall(String userId, String guid, String methodName, org.springframework.core.ParameterizedTypeReference<org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse<T>> type, String urnTemplate, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Integer maximumPageSizeOnRestCall, org.odpi.openmetadata.accessservices.subjectarea.utils.QueryParams queryParams) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a response object by guid.
      Type Parameters:
      T - return type for results in GenericResponse
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      type - class of the response for generic object. Descried using ParameterizedTypeReference An example can be seen here ResponseParameterization.getParameterizedType()
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      findRequest - FindRequest
      maximumPageSizeOnRestCall - maximum page size that can be used on rest calls, null and 0 mean no limit set.
      queryParams - additional parameters to be passed
      Returns:
      GenericResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getConfigRESTCall

      public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse getConfigRESTCall(String userId, String guid, String methodName, Class<org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse> type, String urnTemplate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a Config object by guid.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      type - class of the response for generic object.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      Returns:
      OMAGServerConfigResponse with T result
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getViewServiceConfigRESTCall

      public org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse getViewServiceConfigRESTCall(String userId, String guid, String methodName, Class<org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse> type, String urnTemplate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a View Config object by guid.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - unique identifier of the object
      methodName - name of the method being called.
      type - class of the response for generic object.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      Returns:
      ViewServiceConfigResponse object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getViewConfigRESTCall

      public org.odpi.openmetadata.adminservices.rest.ViewServicesResponse getViewConfigRESTCall(String userId, String methodName, Class<org.odpi.openmetadata.adminservices.rest.ViewServicesResponse> type, String urnTemplate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Issue a GET REST call that returns a View Config object by guid.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      methodName - name of the method being called.
      type - class of the response for generic object.
      urnTemplate - template of the URN for the REST API call with place-holders for the parameters.
      Returns:
      ViewServicesResponse
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid