Package wt.federation

Class FederatedInfoEngineService

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.fc._Item

wt.fc.Item

wt.federation._FederatedInfoEngineService

wt.federation.FederatedInfoEngineService

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, _FederatedService, FederatedService, DisplayIdentification, RemoteAccess

@GenAsPersistable(superClass=Item.class,interfaces={RemoteAccess.class,FederatedService.class},versions=-4596546799523087349L,properties={@GeneratedProperty(name="querySpecTranslator",type=java.lang.String.class),@GeneratedProperty(name="translationTableName",type=java.lang.String.class),@GeneratedProperty(name="objectCacheTTL",type=long.class),@GeneratedProperty(name="objectCacheSize",type=int.class)})
public class FederatedInfoEngineService
extends _FederatedInfoEngineService

This class implements FederatedService objects that use Info*Engine to access remote systems and data sources.

Use the newFederatedInfoEngineService static factory method(s), not the FederatedInfoEngineService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.federation._FederatedInfoEngineService

EXTERNALIZATION_VERSION_UID, OBJECT_CACHE_SIZE, OBJECT_CACHE_TTL, QUERY_SPEC_TRANSLATOR, TRANSLATION_TABLE_NAME

Fields inherited from class wt.fc.Item

SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc._WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

ADMINISTRATIVE_LOCK

Fields inherited from interface wt.admin._DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.federation._FederatedService

ACTION_TABLE, PROXY_EXPIRATION_INTERVAL, PROXY_REFRESH_INTERVAL, SERVICE_NAME, SERVICE_URL, TIGHTLY_COUPLED

Fields inherited from interface wt.fc._Persistable

PERSIST_INFO

Fields inherited from interface wt.access._SecurityLabeled

SECURITY_LABELS

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.federation.FederatedService

FIND_ASSOCIATIONS_BY_CRITERIA, FIND_ASSOCIATIONS_BY_LINK_CLASS, FIND_OBJECTS, RETRIEVE_CONTENTLIST, RETRIEVE_MASTER, RETRIEVE_OBJECT

Fields inherited from interface wt.fc.Persistable

IDENTITY, TYPE

Fields inherited from interface wt.method.RemoteAccess

versionID

Fields inherited from interface wt.access.SecurityLabeled

SECURITY_LABELS_INTERNAL_VALUE

Method Summary

Modifier and Type	Method	Description
QueryResult	findRemoteAssociations(String url, Class linkClass, String role)	Search the remote service for associations matching the criteria specified in the given URL, and return a QueryResult containing objects corresponding to the matching link and other side objects.
QueryResult	findRemoteAssociations(String filterName, Hashtable filterArguments, Class linkClass, String role)	Search the remote service for associations matching the specified search filter, and return a QueryResult containing objects corresponding to the matching link and other side objects.
QueryResult	findRemoteObjects(String url)	Search the remote service for objects matching the criteria specified in the given URL, and return a QueryResult containing the matched objects.
QueryResult	findRemoteObjects(String filterName, Hashtable filterArguments)	Search the remote service for objects matching the specified search filter, and return a QueryResult containing objects corresponding to the matching objects.
InfoEngineTranslationTable	getTranslationTable()	Return an instance of the attribute translation table referenced by this Info*Engine service.
protected void	initialize()	Supports initialization, following construction of an instance.
protected void	initialize(String serviceName)	Supports initialization, following construction of an instance.
protected void	initialize(String serviceName, String serviceURL, String translationTableName, String querySpecTranslator)	Supports initialization, following construction of an instance.
static FederatedInfoEngineService	newFederatedInfoEngineService()	Constructor returning an instance initialized with default property values.
static FederatedInfoEngineService	newFederatedInfoEngineService(String serviceName)	Constructor returning an instance initialized with a specified service name and no directory attribute translation table.
static FederatedInfoEngineService	newFederatedInfoEngineService(String serviceName, String serviceURL, String translationTableName, String querySpecTranslator)	Constructor returning an instance initialized with a specified service name, base service URL, and translation table name.
void	refreshRemoteObject(Federated proxy)	Refreshes the derived properties of a specified proxy object.
Hashtable	retrieveRemoteAttributes(String sourceObjectId)	Return a Java Hashtable object containing all of the attributes read from the specified remote object.
Vector	retrieveRemoteContentList(String sourceObjectId)	Return a Java Vector object containing all of the content items linked to the specified remote object.
Object	retrieveRemoteObject(String sourceObjectId)	Returns a Federated instance of the remote object identified by the specified relative URL.

Methods inherited from class wt.federation._FederatedInfoEngineService

getActionTable, getClassInfo, getConceptualClassname, getObjectCacheSize, getObjectCacheTTL, getProxyExpirationInterval, getProxyRefreshInterval, getQuerySpecTranslator, getServiceName, getServiceURL, getTranslationTableName, getType, isTightlyCoupled, readExternal, readExternal, readVersion, setActionTable, setObjectCacheSize, setObjectCacheTTL, setProxyExpirationInterval, setProxyRefreshInterval, setQuerySpecTranslator, setServiceName, setServiceURL, setTightlyCoupled, setTranslationTableName, super_readExternal_FederatedInfoEngineService, super_readVersion_FederatedInfoEngineService, super_writeExternal_FederatedInfoEngineService, writeExternal, writeExternal

Methods inherited from class wt.fc._Item

getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, toString

Methods inherited from class wt.fc._WTObject

equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newFederatedInfoEngineService

public static FederatedInfoEngineService newFederatedInfoEngineService(String serviceName,
 String serviceURL,
 String translationTableName,
 String querySpecTranslator)
                                                                throws FederationServicesException

Constructor returning an instance initialized with a specified service name, base service URL, and translation table name.

Supported API: true

Parameters:

serviceName -

serviceURL -

translationTableName -

querySpecTranslator -

Returns:

FederatedInfoEngineService

Throws:

FederationServicesException

initialize

protected void initialize(String serviceName,
 String serviceURL,
 String translationTableName,
 String querySpecTranslator)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

serviceName -

serviceURL -

translationTableName -

querySpecTranslator -

Throws:

FederationServicesException

newFederatedInfoEngineService

public static FederatedInfoEngineService newFederatedInfoEngineService(String serviceName)
                                                                throws FederationServicesException

Constructor returning an instance initialized with a specified service name and no directory attribute translation table.

Supported API: true

Parameters:

serviceName -

Returns:

FederatedInfoEngineService

Throws:

FederationServicesException

initialize

protected void initialize(String serviceName)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

serviceName -

Throws:

FederationServicesException

newFederatedInfoEngineService

public static FederatedInfoEngineService newFederatedInfoEngineService()
                                                                throws FederationServicesException,
WTException

Constructor returning an instance initialized with default property values.

Supported API: true

Returns:

FederatedInfoEngineService

Throws:

FederationServicesException

WTException

retrieveRemoteObject

public Object retrieveRemoteObject(String sourceObjectId)
                            throws FederationServicesException,
WTException

Returns a Federated instance of the remote object identified by the specified relative URL.

Supported API: true

Parameters:

sourceObjectId -

Returns:

Object

Throws:

FederationServicesException

WTException

refreshRemoteObject

public void refreshRemoteObject(Federated proxy)
                         throws FederationServicesException,
WTException

Refreshes the derived properties of a specified proxy object.

Supported API: true

Parameters:

proxy -

Throws:

FederationServicesException

WTException

retrieveRemoteAttributes

public Hashtable retrieveRemoteAttributes(String sourceObjectId)
                                   throws FederationServicesException,
WTException

Return a Java Hashtable object containing all of the attributes read from the specified remote object.

Supported API: true

Parameters:

sourceObjectId -

Returns:

Hashtable

Throws:

FederationServicesException

WTException

findRemoteObjects

public QueryResult findRemoteObjects(String filterName,
 Hashtable filterArguments)
                              throws FederationServicesException,
WTException

Search the remote service for objects matching the specified search filter, and return a QueryResult containing objects corresponding to the matching objects.

Supported API: true

Parameters:

filterName -

filterArguments -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

findRemoteObjects

public QueryResult findRemoteObjects(String url)
                              throws FederationServicesException,
WTException

Search the remote service for objects matching the criteria specified in the given URL, and return a QueryResult containing the matched objects.

Supported API: true

Parameters:

url -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

findRemoteAssociations

public QueryResult findRemoteAssociations(String filterName,
 Hashtable filterArguments,
 Class linkClass,
 String role)
                                   throws FederationServicesException,
WTException

Search the remote service for associations matching the specified search filter, and return a QueryResult containing objects corresponding to the matching link and other side objects.

Supported API: true

Parameters:

filterName -

filterArguments -

linkClass -

role -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

findRemoteAssociations

public QueryResult findRemoteAssociations(String url,
 Class linkClass,
 String role)
                                   throws FederationServicesException,
WTException

Search the remote service for associations matching the criteria specified in the given URL, and return a QueryResult containing objects corresponding to the matching link and other side objects.

Supported API: true

Parameters:

url -

linkClass -

role -

Returns:

QueryResult

Throws:

FederationServicesException

WTException

getTranslationTable

public InfoEngineTranslationTable getTranslationTable()
                                               throws FederationServicesException

Return an instance of the attribute translation table referenced by this Info*Engine service.

Supported API: true

Returns:

InfoEngineTranslationTable

Throws:

FederationServicesException

retrieveRemoteContentList

public Vector retrieveRemoteContentList(String sourceObjectId)
                                 throws FederationServicesException,
WTException

Return a Java Vector object containing all of the content items linked to the specified remote object.

Supported API: true

Parameters:

sourceObjectId -

Returns:

Vector

Throws:

FederationServicesException

WTException

initialize

protected void initialize()
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Overrides:

initialize in class Item

Throws:

FederationServicesException