Class 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:
    Serialized Form
    • Field Detail

      • 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:
        Constant Field Values
      • SERVER_TYPE_AZURE_STORAGE

        public static final String SERVER_TYPE_AZURE_STORAGE
        The "Azure Storage" server type.
        See Also:
        Constant Field Values
      • SERVER_TYPE_HTTP_ENDPOINT

        public static final String SERVER_TYPE_HTTP_ENDPOINT
        The "HTTP Endpoint" server type.
        See Also:
        Constant Field Values
      • SERVER_TYPE_SALESFORCE

        public static final String SERVER_TYPE_SALESFORCE
        The "SalesForce" server type.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • TRANSPORT_PROTOCOL_SOAP

        public static final String TRANSPORT_PROTOCOL_SOAP
        The "SOAP" transport protocol.
        See Also:
        Constant Field Values
      • TRANSPORT_PROTOCOL_REST

        public static final String TRANSPORT_PROTOCOL_REST
        The "REST" transport protocol.
        See Also:
        Constant Field Values
      • TRANSPORT_PROTOCOLS

        public static final String[] TRANSPORT_PROTOCOLS
        The transport protocols.
    • Constructor Detail

      • ServiceConnection

        public ServiceConnection()
    • Method Detail

      • 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