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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME_AND_CLIENT_STRING_PROPERTY
An auxiliary property combining connection name and client code, which together uniquely identify a service connectionstatic String
SERVER_TYPE_AWS_KMS
The "AWS KMS" server type.static String
SERVER_TYPE_AWS_S3
The "AWS S3" server type.static String
SERVER_TYPE_AWS_SQS
The "AWS SQS" server type.static String
SERVER_TYPE_AWS_STS
The "AWS STS" server type.static String
SERVER_TYPE_AZURE_STORAGE
The "Azure Storage" server type.static String
SERVER_TYPE_DOCUSIGN
The "DocuSign" server type.static String
SERVER_TYPE_HTTP_ENDPOINT
The "HTTP Endpoint" server type.static String
SERVER_TYPE_JBOSS
The "JBoss" server type.static String
SERVER_TYPE_SALESFORCE
The "SalesForce" server type.static String
SERVER_TYPE_TIG
The "TIG" server type.static String
SERVER_TYPE_WEBLOGIC
The "WebLogic" server type.static String
SERVER_TYPE_WEBSPHERE
The "WebSphere" server type.static String[]
SERVER_TYPES
The server types.static String
TRANSPORT_PROTOCOL_EJB
The "EJB" transport protocol.static String
TRANSPORT_PROTOCOL_REST
The "REST" transport protocol.static String
TRANSPORT_PROTOCOL_SOAP
The "SOAP" transport protocol.static String[]
TRANSPORT_PROTOCOLS
The transport protocols.-
Fields inherited from class com.avoka.fc.core.entity.auto._ServiceConnection
APPLICATION_CONNECTION_LIST, APPLICATION_CONNECTION_LIST_PROPERTY, CLIENT, CLIENT_PROPERTY, CONNECTION_OID_PK_COLUMN, ENDPOINT_VALUE, ENDPOINT_VALUE_PROPERTY, FILE_DATA, FILE_DATA_PROPERTY, FILE_NAME, FILE_NAME_PROPERTY, NAME, NAME_PROPERTY, PARAM1, PARAM1_PROPERTY, PARAM2, PARAM2_PROPERTY, PARAM3, PARAM3_PROPERTY, PARAM4, PARAM4_PROPERTY, PASSWORD, PASSWORD_PROPERTY, SERVER_TYPE, SERVER_TYPE_PROPERTY, SERVICE, SERVICE_ENVIRONMENT, SERVICE_ENVIRONMENT_PROPERTY, SERVICE_PROPERTY, TRANSPORT, TRANSPORT_PROPERTY, USE_AUTH_MANAGER_FLAG, USE_AUTH_MANAGER_FLAG_PROPERTY, USERNAME, USERNAME_PROPERTY
-
Fields inherited from class com.avoka.core.entity.BaseEntity
ID_PROPERTY
-
-
Constructor Summary
Constructors Constructor Description ServiceConnection()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getNameAndClientString()
Return a combination of the connection name and -if the connection is client specific - the client code.String
getPassword()
Gets the password.boolean
isEJBTransport()
Return true if the transport protocol is EJB.boolean
isRESTTransport()
Return true if the transport protocol is REST.boolean
isSOAPTransport()
Return true if the transport protocol is SOAP.void
setPassword(String value)
Sets the password.boolean
useAuthManager()
Return whether the connection will be using the Authentication Manager-
Methods inherited from class com.avoka.fc.core.entity.auto._ServiceConnection
addToApplicationConnectionList, addToService, getApplicationConnectionList, getClient, getEndpointValue, getFileData, getFileName, getName, getParam1, getParam2, getParam3, getParam4, getServerType, getService, getServiceEnvironment, getTransport, getUsername, isUseAuthManagerFlag, removeFromApplicationConnectionList, removeFromService, setClient, setEndpointValue, setFileData, setFileName, setName, setParam1, setParam2, setParam3, setParam4, setServerType, setServiceEnvironment, setTransport, setUseAuthManagerFlag, setUsername
-
Methods inherited from class com.avoka.core.entity.BaseEntity
appendProperties, getId, getValuesMap, isNew, setId, toString
-
Methods inherited from class org.apache.cayenne.CayenneDataObject
makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState
-
Methods inherited from class org.apache.cayenne.BaseDataObject
addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized
-
Methods inherited from class org.apache.cayenne.PersistentObject
getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.avoka.fc.core.entity.Auditable
getId, getValuesMap
-
-
-
-
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_AWS_KMS
public static final String SERVER_TYPE_AWS_KMS
The "AWS KMS" server type.- See Also:
- Constant Field Values
-
SERVER_TYPE_AWS_S3
public static final String SERVER_TYPE_AWS_S3
The "AWS S3" server type.- See Also:
- Constant Field Values
-
SERVER_TYPE_AWS_SQS
public static final String SERVER_TYPE_AWS_SQS
The "AWS SQS" server type.- See Also:
- Constant Field Values
-
SERVER_TYPE_AWS_STS
public static final String SERVER_TYPE_AWS_STS
The "AWS STS" server type.- 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_DOCUSIGN
public static final String SERVER_TYPE_DOCUSIGN
The "DocuSign" 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_JBOSS
public static final String SERVER_TYPE_JBOSS
The "JBoss" 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_TYPE_TIG
public static final String SERVER_TYPE_TIG
The "TIG" server type.- See Also:
- Constant Field Values
-
SERVER_TYPE_WEBLOGIC
public static final String SERVER_TYPE_WEBLOGIC
The "WebLogic" server type.- See Also:
- Constant Field Values
-
SERVER_TYPE_WEBSPHERE
public static final String SERVER_TYPE_WEBSPHERE
The "WebSphere" 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.
-
-
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
-
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:
_ServiceConnection.getPassword()
-
setPassword
public void setPassword(String value)
Sets the password.- Overrides:
setPassword
in class_ServiceConnection
- Parameters:
value
- the new password- See Also:
_ServiceConnection.setPassword(java.lang.String)
-
-