|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An EntireNetwork
object represents all of the
object stores (libraries) on the network. This interface defines methods for
returning a collection of ObjectStore objects, and for returning an XML list of object stores.
Note that the object stores known to an EntireNetwork
object are derived from
EntireNetwork.properties, a configuration file in the CS Java Toolkit.
To create an EntireNetwork
object, call
ObjectFactory.getEntireNetwork()
,
supplying the required Session
object
as an argument. For example:
Session oSession = ObjectFactory.getSession("com.example.apps.MyTestApp", null,
"tester", null, null);
EntireNetwork oNetwork = ObjectFactory.getEntireNetwork(oSession);
Method Summary | |
Domains |
getDomains()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getDomainsXML(java.lang.String[] propNames)
Not Implemented in CS Java Connector v3.0. |
ObjectStores |
getObjectStores()
Deprecated. Returns an ObjectStores collection object whose elements are
ObjectStore objects known to the
Active Directory on the Content Services server and
to which the current user has access. (The current user is
identified in the Session object.)
This method checks the caller's permission to access each object store
but does not login to each object store. Therefore, this method
returns and caches only the object store properties that are available without
performing a login (for example, Name, DisplayName, DatabaseServerName, and
Domain properties). (Note that the
|
java.lang.String |
getObjectStoresXML(java.lang.String[] propNames)
Returns a String that contains an XML representation of all of the
object stores (and their properties, specified as symbolic names)
known to the Active Directory on the Content Services server and
to which the current user has access. |
Realms |
getRealms()
Not Implemented in CS Java Connector v3.0. |
Realm |
getUserRealm()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getUserRealmXML()
Not Implemented in CS Java Connector v3.0. |
Method Detail |
public ObjectStores getObjectStores()
ObjectStores
collection object whose elements are
ObjectStore
objects known to the
Active Directory on the Content Services server and
to which the current user has access. (The current user is
identified in the Session
object.)
This method checks the caller's permission to access each object store
but does not login to each object store. Therefore, this method
returns and caches only the object store properties that are available without
performing a login (for example, Name, DisplayName, DatabaseServerName, and
Domain properties). (Note that the
getObjectStoresXML
method can return all available object store
properties.)
ObjectStores
collection object.public java.lang.String getObjectStoresXML(java.lang.String[] propNames)
String
that contains an XML representation of all of the
object stores (and their properties, specified as symbolic names)
known to the Active Directory on the Content Services server and
to which the current user has access. (The current user is
identified in the Session
object.)
If the propNames
array is empty or null
,
this method returns all properties for the object stores to which the
current user has access. If the array includes properties that do not
exist for the object stores, those properties are ignored (no exception
is thrown).
propNames
- A String
array whose elements
specify the symbolic names of the properties to return.
(If you pass in a null
, you must first
explicitly cast it to a String[] to avoid a compilation error.)
String
containing an XML representation of the object stores and
their requested properties.public java.lang.String getDomainsXML(java.lang.String[] propNames)
Not Implemented in CS Java Connector v3.0.
Returns aString
that contains an XML representation of all
of the domains
(and their requested properties, specified as symbolic names) known to
the Active Directory on the Content Services server.
If the propNames
array is empty or null
,
this method returns all properties for all domains known to the Active
Directory on the Content Services server. If the array includes properties
that do not exist for the domains, those properties are ignored (no
exception is thrown).
propNames
- A String
array whose
elements specify the symbolic names of the properties to return.
(If you pass in a null
, you must first explicitly cast it
to a String[] to avoid a compilation error.)
String
containing an XML representation of the
domains known to the Active Directory and their requested properties.public Domains getDomains()
Not Implemented in CS Java Connector v3.0.
Returns aDomains
collection object whose elements
represent all the Domain
objects know to the Active
Directory on the Content Services server.
Domains
collection object.public Realms getRealms()
Not Implemented in CS Java Connector v3.0.
Returns a collection ofRealm
objects.
The elements of the returned collection represent the domains in the local
forest, the domain of the current user, and the domains trusted by the
domains of the local forest.
Realms
collection object.public Realm getUserRealm()
Not Implemented in CS Java Connector v3.0.
Returns aRealm
object for the trusted domain in which the
current user resides.
This method provides a convenient way to locate the realm
of the current user.
Realm
object of the current user.public java.lang.String getUserRealmXML()
Not Implemented in CS Java Connector v3.0.
Returns aString
that contains an XML representation of the
realm in which the current user resides.
String
containing XML that represents the
Realm
object for the current user.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |