|
JCC v1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The JcpPeer interface represents a vendor's particular implementation of the JCP API.
Other interfaces
derived from JCP for example, JTAPI, JCC, etc. are expected to implement this interface.
The JcpPeer object, returned
by the JcpPeerFactory.getJcpPeer(String)
method, determines which JcpProviders are made
available to
the application.
Applications use the getProvider(String)
method on this interface to obtain new JcpProvider
objects. Each implementation may support one or more different "services". A list of available
services can be obtained via the getServices()
method.
getProvider(String)
method on this
interface to obtain new JcpProvider objects. Each implementation may support
one or more different "services" (e.g. for different types of underlying
network substrate). A list of available services can be obtained via the
getServices()
method.
Applications may also
supply optional arguments to the JcpProvider through the
getProvider(String)
method. These arguments are appended to
the providerString
argument passed to the
getProvider(String)
method. The providerString
argument has the following format:
< service name > ; arg1 = val1; arg2 = val2; ...
Where < service name > is not optional, and each optional argument pair which follows is separated by a semi-colon. The keys for these arguments is implementation specific, except for two standard-defined keys:
Method Summary | |
java.lang.String |
getName()
Returns the name of this JcpPeer object instance. |
JcpProvider |
getProvider(java.lang.String providerString)
Returns an instance of a Provider object given a string
argument which contains the desired service name. |
java.lang.String[] |
getServices()
Returns the services that this implementation supports. |
Method Detail |
public java.lang.String getName()
JcpPeerFactory.getJcpPeer(String)
method.
public java.lang.String[] getServices()
public JcpProvider getProvider(java.lang.String providerString) throws ProviderUnavailableException
Provider
object given a string
argument which contains the desired service name. Optional arguments may also
be provided in this string, with the following format: < service name > ; arg1 = val1; arg2 = val2; ...
Where < service name > is not optional, and each optional argument pair which follows is separated by a semi-colon. The keys for these arguments is implementation specific, except for two standard-defined keys:
If the argument is null, this method returns some default Provider as
determined by the JCPPeer object. The returned Provider is not in the
JcpProvider.SHUTDOWN
state.Note that this may also result in
the application obtaining a reference to a Provider which has already been
created.
Post-conditions:
providerString
- is the name of the desired service.ProviderUnavailableException
- indicates a Provider corresponding to the given string
is unavailable.
|
JCC v1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |