|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Connection
Represents a logical connection to a FileNet P8 domain.
A domain connection is required to obtain a reference to any object stores
within that domain. A Connection
object contains information, such as configuration
options, needed to execute an operation on the Content Engine server that runs
in the FileNet P8 domain.
A Connection
object contains enough information to establish communication
with the Content Engine server. This information is carried in a URI and
includes the transport protocol (connection type), host name, and port number
that are used for server communication. An incorrect configuration, such as an
incompatibility between the environment and the information in the Connection
object, is the most frequent cause of an exception related to a connection failure.
For example, if the URI carried by the Connection
object specifies the Enterprise Java™Beans (EJB)
transport protocol but an EJB .jar file is not in the classpath, the API throws an exception.
You can create a Connection
object by calling one of the static getConnection
methods on the
Factory.Connection
class.
Once you have obtained a Connection
object, you can call its methods to
retrieve information about the connection.
All engine objects maintain a reference to the connection instance, which you
can retrieve by calling the engine object's getConnection
method. The
Connection
object is also used as an input to factory methods that create other objects.
Examples are Factory.Domain.getInstance(Connection conn, String name)
and
Factory.EntireNetwork.getInstance(Connection conn)
.
Method Summary | |
---|---|
ConnectionType |
getConnectionType()
Returns a ConnectionType object, which identifies the transport
protocol associated with this connection. |
java.lang.Object |
getParameter(ConfigurationParameter parameter)
Retrieves the specified configuration parameter. |
java.lang.String |
getURI()
Returns the Universal Resource Identity (URI) for this connection. |
java.lang.Object |
setParameter(ConfigurationParameter parameter,
java.lang.Object value)
Sets a configuration parameter. |
void |
setParameters(ConfigurationParameters parameters)
Sets the configuration parameters specified in the parameters
argument. |
Method Detail |
---|
java.lang.String getURI()
String
containing the URI.ConnectionType getConnectionType()
ConnectionType
object, which identifies the transport
protocol associated with this connection. Supported transport protocols are
EJB and SOAP (that is, the web services interface to the Content Engine server, based on the SOAP protocol).
ConnectionType
object, which can be either EJB or SOAP.java.lang.Object getParameter(ConfigurationParameter parameter)
parameter
- Configuration parameter value to retrieve. See the
ConfigurationParameter
class.
null
if not set.java.lang.Object setParameter(ConfigurationParameter parameter, java.lang.Object value)
value
argument is null
, this method removes the value. Defaults are used for removed values.
parameter
- The configuration parameter to set. See the ConfigurationParameter
class.value
- The value of the parameter to set, or null
. See
the ConfigurationParameter
class.
EngineRuntimeException
- if the specified parameters are
invalid.ExceptionCode.API_INVALID_CONNECTION_PARAMETER
void setParameters(ConfigurationParameters parameters)
parameters
argument. Other configuration parameters are unchanged. This is equivalent
to calling setParameter(ConfigurationParameter parameter, Object value)
for each
parameter with a non-null
value in its parameter
argument.
parameters
- A ConfigurationParameters
collection.
EngineRuntimeException
- if one or more
parameters are invalid.ExceptionCode.API_INVALID_CONNECTION_PARAMETER
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |