Package com.avoka.fc.core.entity

Class ServiceConnection

java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._ServiceConnection
com.avoka.fc.core.entity.ServiceConnection
All Implemented Interfaces:
IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
@CacheGroups("CONFIG") public class ServiceConnection extends _ServiceConnection implements Auditable
Provides an entity describing connection details to an external service.
See Also:

  • Field Details

    • NAME_AND_CLIENT_STRING_PROPERTY

      public static final String NAME_AND_CLIENT_STRING_PROPERTY
      An auxiliary property combining connection name and client code, which together uniquely identify a service connection
      See Also:

    • SERVER_TYPE_AWS_KMS

      public static final String SERVER_TYPE_AWS_KMS
      The "AWS KMS" server type.
      See Also:

    • SERVER_TYPE_AWS_S3

      public static final String SERVER_TYPE_AWS_S3
      The "AWS S3" server type.
      See Also:

    • SERVER_TYPE_AWS_SQS

      public static final String SERVER_TYPE_AWS_SQS
      The "AWS SQS" server type.
      See Also:

    • SERVER_TYPE_AWS_STS

      public static final String SERVER_TYPE_AWS_STS
      The "AWS STS" server type.
      See Also:

    • SERVER_TYPE_AZURE_STORAGE

      public static final String SERVER_TYPE_AZURE_STORAGE
      The "Azure Storage" server type.
      See Also:

    • SERVER_TYPE_DOCUSIGN

      public static final String SERVER_TYPE_DOCUSIGN
      The "DocuSign" server type.
      See Also:

    • SERVER_TYPE_DOCUSIGN_OAUTH

      public static final String SERVER_TYPE_DOCUSIGN_OAUTH
      The "DocuSign OAuth" server type.
      See Also:

    • SERVER_TYPE_HTTP_ENDPOINT

      public static final String SERVER_TYPE_HTTP_ENDPOINT
      The "HTTP Endpoint" server type.
      See Also:

    • SERVER_TYPE_JBOSS

      public static final String SERVER_TYPE_JBOSS
      The "JBoss" server type.
      See Also:

    • SERVER_TYPE_KAFKA

      public static final String SERVER_TYPE_KAFKA
      The "Kafka" server type.
      See Also:

    • SERVER_TYPE_SALESFORCE

      public static final String SERVER_TYPE_SALESFORCE
      The "SalesForce" server type.
      See Also:

    • SERVER_TYPE_TIG

      public static final String SERVER_TYPE_TIG
      The "TIG" server type.
      See Also:

    • SERVER_TYPE_WEBLOGIC

      public static final String SERVER_TYPE_WEBLOGIC
      The "WebLogic" server type.
      See Also:

    • SERVER_TYPE_WEBSPHERE

      public static final String SERVER_TYPE_WEBSPHERE
      The "WebSphere" server type.
      See Also:

    • SERVER_TYPES

      public static final String[] SERVER_TYPES
      The server types.

    • TRANSPORT_PROTOCOL_EJB

      public static final String TRANSPORT_PROTOCOL_EJB
      The "EJB" transport protocol.
      See Also:

    • TRANSPORT_PROTOCOL_SOAP

      public static final String TRANSPORT_PROTOCOL_SOAP
      The "SOAP" transport protocol.
      See Also:

    • TRANSPORT_PROTOCOL_REST

      public static final String TRANSPORT_PROTOCOL_REST
      The "REST" transport protocol.
      See Also:

    • TRANSPORT_PROTOCOLS

      public static final String[] TRANSPORT_PROTOCOLS
      The transport protocols.

  • Constructor Details

    • ServiceConnection

      public ServiceConnection()

  • Method Details

    • getNameAndClientString

      public String getNameAndClientString()
      Return a combination of the connection name and -if the connection is client specific - the client code. Please use this method for displaying service connections to users rather than getName() as service connection names are no longer globally unique.
      Returns:
      a string combining connection name and client code
      Since:
      5.0.0

    • isEJBTransport

      public boolean isEJBTransport()
      Return true if the transport protocol is EJB.
      Returns:
      true if the transport protocol is EJB

    • isRESTTransport

      public boolean isRESTTransport()
      Return true if the transport protocol is REST.
      Returns:
      true if the transport protocol is REST

    • isSOAPTransport

      public boolean isSOAPTransport()
      Return true if the transport protocol is SOAP.
      Returns:
      true if the transport protocol is SOAP

    • useAuthManager

      public boolean useAuthManager()
      Return whether the connection will be using the Authentication Manager
      Returns:
      the same value as _ServiceConnection.isUseAuthManagerFlag()

    • getPassword

      public String getPassword()
      Gets the password.
      Overrides:
      getPassword in class _ServiceConnection
      Returns:
      the password
      See Also:

    • setPassword

      public void setPassword(String value)
      Sets the password.
      Overrides:
      setPassword in class _ServiceConnection
      Parameters:
      value - the new password
      See Also: