Package org.imixs.melman

Class AbstractClient

java.lang.Object
org.imixs.melman.AbstractClient
Direct Known Subclasses:
DocumentClient, EventLogClient, ModelClient
public abstract class AbstractClient extends Object
This AbstractClient provides core functionality of a JAX Rest Client and the feature to register authentication filters.
Author:
Ralph Soika

  • Field Details

    • baseURI

      protected String baseURI

    • sslContext

      protected SSLContext sslContext

    • requestFilterList

      protected List<jakarta.ws.rs.client.ClientRequestFilter> requestFilterList

  • Constructor Details

    • AbstractClient

      public AbstractClient(String base_uri)
      Initialize the client by a BASE_URL.
      Parameters:
      base_uri -

  • Method Details

    • getSslContext

      public SSLContext getSslContext()

    • setSslContext

      public void setSslContext(SSLContext sslContext)

    • registerClientRequestFilter

      public void registerClientRequestFilter(jakarta.ws.rs.client.ClientRequestFilter filter)
      Register a ClientRequestFilter instance.
      Parameters:
      filter - - request filter instance.

    • getRequestFilterList

      public List<jakarta.ws.rs.client.ClientRequestFilter> getRequestFilterList()

    • getBaseURI

      public String getBaseURI()

    • setBaseURI

      public void setBaseURI(String baseURI)

    • newClient

      public jakarta.ws.rs.client.Client newClient()
      This method creates a new javax.ws.rs.client.Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

      The method registers all known filter instances.

      The client instance should be closed after the request if finished.

      The method verifies if a sslContext exists. In this case a client this context will be generated

      Returns:
      javax.ws.rs.client.Client instance

    • logout

      public void logout()
      Calls the /logout/ target of the rest api endpoint
      Parameters:
      client -
      Throws:
      RestAPIException

    • getCustomResource

      public List<org.imixs.workflow.ItemCollection> getCustomResource(String uri) throws RestAPIException
      Returns the custom data list by uri GET
      Parameters:
      userid -
      items -
      Returns:
      result list
      Throws:
      RestAPIException

    • getCustomResourceXML

      public org.imixs.workflow.xml.XMLDataCollection getCustomResourceXML(String uri) throws RestAPIException
      Returns the custom data list by uri GET as a collection of XMLDocument elements.
      Parameters:
      userid -
      items -
      Returns:
      result list of XMLDocument elements
      Throws:
      RestAPIException

    • getWebTarget

      public jakarta.ws.rs.client.WebTarget getWebTarget(String uri) throws RestAPIException
      Returns a WebTarget object for a given uri.
      Parameters:
      uri -
      Returns:
      WebTarget
      Throws:
      RestAPIException