|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAnnotatedConnectionService
Interface for connection configuration persistence.
This service leverages annotated classes for persistence and retrieval of connection configurations. In addition, classes can be annotated for localization (see L10n, L10nName, L10nDesc
) for localized metadata about the connections.
The following code is an example of an annotated class:
package test.connection; import oracle.wcps.l10n.annotation.L10n; import oracle.wcps.l10n.annotation.L10nName; import oracle.wcps.l10n.annotation.L10nDesc; import oracle.wcps.connection.configuration.RemoteHttpAnnotatedConfiguration; @L10n(bundle="test.connection.ConfigurationResources") @ConnectionConfiguration public class MyProxyConnectionConfiguration extends RemoteHttpAnnotatedConfiguration { @L10nDesc(key="ProxyHost.description") // Uses default "ProxyHost" as the property name by the backing store. @ConnectionProperty public String ProxyHost; @L10nDesc(key="ProxyPort.description") // Uses "proxy.port" as the property name by the backing store. @ConnectionProperty (propertyname="proxy_port") public Integer ProxyPort; }
Field Summary | |
---|---|
static java.lang.String |
GLOBAL_NAMESPACE_NAME Represents the namespace that indicates that the connection applies globally. |
Method Summary | ||
---|---|---|
|
getConnection(java.lang.String namespace, java.lang.Class<T> configClass, java.lang.String name) Retrieves an existing connection based on the provided namespace, configuration class and name. |
|
|
getConnections(java.lang.Class<T> configClass) Retrieves existing connections based on the provided configuration class. |
|
|
getConnections(java.lang.String namespace, java.lang.Class<T> configClass) Retrieves existing connections based on the provided configuration class. |
|
|
removeConnection(java.lang.Class<T> configClass, java.lang.String name) Removes a connection by name from the global connections namespace. |
|
|
removeConnection(java.lang.String namespace, java.lang.Class<T> configClass, java.lang.String name) Removes a connection by name. |
|
|
saveConnection(java.lang.String namespace, T configuration) Persists a connection with the configured backing store. |
|
|
saveConnection(T configuration) Persists a connection with the configured backing store. |
Field Detail |
---|
static final java.lang.String GLOBAL_NAMESPACE_NAME
Method Detail |
---|
<T> java.util.List<T> getConnections(java.lang.String namespace, java.lang.Class<T> configClass)
namespace
- The namespace used to isolate connections for tennancy.configClass
- The annotated configuration class used to represent each connection.<T> java.util.List<T> getConnections(java.lang.Class<T> configClass)
This method returns all connections (both namespaced and global) for a given connection type.
configClass
- The annotated configuration class used to represent each connection.<T> T getConnection(java.lang.String namespace, java.lang.Class<T> configClass, java.lang.String name)
namespace
- The namespace used to isolate connections for tennancy.configClass
- The annotated configuration class used to represent each connection.name
- The named connection to retrieve<T> T saveConnection(java.lang.String namespace, T configuration)
namespace
- The namespace used to isolate connections for tennancy.configuration
- Instance of the annotated configuration class used to represent each connection.<T> T saveConnection(T configuration)
Connections persisted using this method will be globally accessible to all namespaces.
configuration
- Instance of the annotated configuration class used to represent each connection.<T> void removeConnection(java.lang.String namespace, java.lang.Class<T> configClass, java.lang.String name)
namespace
- The namespace used to isolate connections for tenancy.configClass
- The annotated configuration class used to represent each connection.name
- The connection name to remove.<T> void removeConnection(java.lang.Class<T> configClass, java.lang.String name)
configClass
- The annotated configuration class used to represent each connection.name
- The connection name to remove.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |