com.ibm.wsspi.sibx.mediation.wsrr.client

Interface ServiceRegistryProxy


  1. public interface ServiceRegistryProxy
The interface that can be used to communicate with a service registry and its cache

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
$sccsid
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. int
cacheDepth()
Return the number of queries that are currently cached.
  1. void
clearCache()
Clear the cache for this service registry proxy.
  1. java.lang.String
create(DataGraphType dataGraphList)
Create an object in the service registry that matches a given dataGraphType
  1. void
delete(java.lang.String bsiUri)
Delete the object within the registry with the supplied bsrURI
  1. ServiceRegistryDataGraphList
get(java.lang.String bsiUri)
Retrieve an object from the service registry that matches a given bsiUri.
  1. ServiceRegistryDataGraphList
get(java.lang.String bsiUri,int depth)
Retrieve an object from the service registry that matches a given bsiUri.
  1. boolean
isConnectionSuccessful()
Test that this Service Registry can be connected to.
  1. ServiceRegistryDataGraphList
namedQuery(java.lang.String namedQuery,java.lang.String[] params)
Given a named query and array of parameters, return all the content and values that are matched in WSRR.
  1. ServiceRegistryDataGraphList
namedQuery(java.lang.String namedQuery,java.lang.String[] params,EventPoint eventPoint)
Given a named query and array of parameters, return all the content and values that are matched in WSRR.
  1. ServiceRegistryDataGraphList
query(java.lang.String queryStatement)
Given a query statement, return all the content and values that are matched in WSRR.
  1. ServiceRegistryDataGraphList
query(java.lang.String queryStatement,int depth)
Given a query statement and the depth of the search, return all the content and values that are matched in WSRR.
  1. ServiceRegistryDataGraphList
query(java.lang.String queryStatement,int depth,boolean noContent)
Given a query statement, the depth of the search and if any content will be returned or not, return the values that are matched in WSRR.
  1. ServiceRegistryDataGraphList
query(java.lang.String queryStatement,int depth,boolean noContent,EventPoint eventPoint)
Given a query statement, the depth of the search and if any content will be returned or not, return the values that are matched in WSRR.
  1. void
update(DataGraphType dataGraphList)
Update an object in the service registry that matches a given dataGraphType

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

$sccsid

  1. static final java.lang.String $sccsid
See Also:

Method Detail

query

  1. ServiceRegistryDataGraphList query( java.lang.String queryStatement,
  2. int depth,
  3. boolean noContent,
  4. EventPoint eventPoint)
  5. throws ServiceRegistryProxyException
Given a query statement, the depth of the search and if any content will be returned or not, return the values that are matched in WSRR.
Parameters:
queryStatement - The XPath query
depth - The search depth. -1 for infinite depth
noContent - True if no document content is to be retrieved from the search
eventPoint - event point for monitoring events.
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

query

  1. ServiceRegistryDataGraphList query( java.lang.String queryStatement,
  2. int depth,
  3. boolean noContent)
  4. throws ServiceRegistryProxyException
Given a query statement, the depth of the search and if any content will be returned or not, return the values that are matched in WSRR.
Parameters:
queryStatement - The XPath query
depth - The search depth. -1 for infinite depth
noContent - True if no document content is to be retrieved from the search
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

query

  1. ServiceRegistryDataGraphList query( java.lang.String queryStatement,
  2. int depth)
  3. throws ServiceRegistryProxyException
Given a query statement and the depth of the search, return all the content and values that are matched in WSRR. Equivalent to calling query(queryStatement, depth, false).
Parameters:
queryStatement - The XPath query
depth - The search depth. -1 for infinite depth
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

query

  1. ServiceRegistryDataGraphList query( java.lang.String queryStatement)
  2. throws ServiceRegistryProxyException
Given a query statement, return all the content and values that are matched in WSRR. Equivalent to calling query(queryStatement, -1, false).
Parameters:
queryStatement - The XPath query
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

namedQuery

  1. ServiceRegistryDataGraphList namedQuery( java.lang.String namedQuery,
  2. java.lang.String[] params)
  3. throws ServiceRegistryProxyException
Given a named query and array of parameters, return all the content and values that are matched in WSRR.
Parameters:
namedQuery - The named query being called
params - A String array containing the required parameters
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

namedQuery

  1. ServiceRegistryDataGraphList namedQuery( java.lang.String namedQuery,
  2. java.lang.String[] params,
  3. EventPoint eventPoint)
  4. throws ServiceRegistryProxyException
Given a named query and array of parameters, return all the content and values that are matched in WSRR.
Parameters:
namedQuery - The named query being called
params - A String array containing the required parameters
eventPoint - event point for monitoring events.
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

isConnectionSuccessful

  1. boolean isConnectionSuccessful( )
  2. throws ServiceRegistryProxyException
Test that this Service Registry can be connected to. Return true if the connection have been successful.
Throws:

get

  1. ServiceRegistryDataGraphList get( java.lang.String bsiUri,
  2. int depth)
  3. throws ServiceRegistryProxyException
Retrieve an object from the service registry that matches a given bsiUri.
Parameters:
bsiUri - The WSRR bsiURI string
depth - The search depth. -1 for infinite depth
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

get

  1. ServiceRegistryDataGraphList get( java.lang.String bsiUri)
  2. throws ServiceRegistryProxyException
Retrieve an object from the service registry that matches a given bsiUri. Equivalent to calling get(bsiUri, -1).
Parameters:
bsiUri - The WSRR bsiURI string
Returns:
A ServiceRegistryDataGraphList object containing the list of matching DataGraphType objects and a time stamp for the query
Throws:

create

  1. java.lang.String create(DataGraphType dataGraphList)
  2. throws ServiceRegistryProxyException
Create an object in the service registry that matches a given dataGraphType
Returns:
bsrUri The WSRR bsiURI of the create object in WSRR
Throws:

delete

  1. void delete(java.lang.String bsiUri)
  2. throws ServiceRegistryProxyException
Delete the object within the registry with the supplied bsrURI
Parameters:
bsiUri - The WSRR bsiURI string
Throws:

update

  1. void update(DataGraphType dataGraphList)
  2. throws ServiceRegistryProxyException
Update an object in the service registry that matches a given dataGraphType
Throws:

clearCache

  1. void clearCache()
Clear the cache for this service registry proxy.

cacheDepth

  1. int cacheDepth()
Return the number of queries that are currently cached.