Page History
Scrollbar | ||
---|---|---|
|
...
Page info | ||||
---|---|---|---|---|
|
Panel | ||||
---|---|---|---|---|
| ||||
|
...
org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter
, ororg.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
Option 1, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter provides an interface for interacting with the LexEVS Grid Services. This Interface is intended to mirror the existing LexEVS API as much as possible. There is no object wrapping for semantic purposes on this interface. This allows existing applications of the LexEVS API to use Grid Services without code changes.
This Interface may be acquired by instantiating LexBIGServiceAdapter with the Grid Service URL as a parameter.Code Block LexBIGService lbs = new LexBIGServiceAdapter ("http://lexevsapi-analytical50.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService");
Option 2, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter also provides an interface for interacting with the LexEVS Grid Services. However, this Interfaces is the semantically defined interface. All method parameters and return values are defined and annotated as CDEs to be loaded into caDSR. This Interface is intended to be caGrid Silver Level Compliant.
This Interface may be acquired by instantiating LexBIGServiceGridAdapter with the Grid Service URL as a parameter.Code Block LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter ("http://lexevsapi-analytical50.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService);
...
Description: | Returns the set of all (or all active) concepts in the specified coding scheme. | ||||||
---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.CodedNodeSet.stubs.types.CodedNodeSetReference | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
| ||||||
Sample Call; | Sample Call:
|
...
Description: | Returns an instance of the filter extension registered with the given name. | ||||||
---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Filter.stubs.types.FilterReference | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation :
| ||||||
Sample Call: | Sample Call:
|
...
Description: | Returns an instance of the sort extension registered with the given name. | ||||||
---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification | ||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort. | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
| ||||||
Sample Call: | Sample Call:
|
...
Description: | Returns a description of all registered extensions used to provide additional filtering of query results. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output | org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
|
...
Description: | Return an interface to perform system-wide query over metadata for loaded code systems and providers. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.LexBIGServiceMetadata. | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
| ||||
Sample Call: | Sample Call: '
|
...
Description: | Return a list of coding schemes and versions that are supported by this service, along with their status. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
|
...
Description: | Return the last time that the content of this service was changed; null if no changes have occurred. Tag assignments do not count as service changes for this purpose. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | java.util.Date | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
|
...
Description: | Return detailed coding scheme information given a specific tag or version identifier. | ||||||
---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag | ||||||
Output: | org.LexGrid.codingSchemes.CodingScheme | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation:
|
...
Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification | ||||||||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices. | ||||||||||
Exception: | RemoteException | ||||||||||
Implementation Details: | Implementation:
| ||||||||||
Sample Call: | Sample Call :
|
...
Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.
| |||||
---|---|---|---|---|---|---|
Input: | none | |||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList | |||||
Exception: | RemoteException | |||||
Implementation Details: | Implementation:
|
...
Description: | Returns an instance of the application-specific extension registered with the given name. | |||||||
---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification | |||||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList | |||||||
Exception: | RemoteException | |||||||
Implementation Details: | Implementation :
|
...
Description: | Resolve a reference to the history api servicing the given coding scheme. | ||||
---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification | ||||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices. | ||||
Exception: | RemoteException | ||||
Implementation Details: | Implementation :
| ||||
Sample Call: | Sample Call :
|
...
Description: | Returns a description of all registered extensions used to provide additional filtering of query results. | ||
---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.InterfaceElements.types.SortContext | ||
Output: | org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList | ||
Exception: | RemoteException | ||
Implementation Details: | Implementation :
|
...
Description: | Return coding scheme copyright given a specific tag or version identifier. | ||||||
---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification | ||||||
Output: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight | ||||||
Exception: | RemoteException | ||||||
Implementation Details: | Implementation :
|
...
Description: | Sets the Security Token for the given Coding Scheme. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification, gov.nih.nci.evs.security.SecurityToken | ||||||||
Output: | org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LexEVSGridServiceReference.LexEVSGridServiceReference | ||||||||
Exception: | RemoteException | ||||||||
Implementation Details: | Implementation :
|
...
For your convenience, the required libraries are available for download here:
https://gforge.nci.nih.gov/docman/view.php/491/14401/lexevs42-gridsrvc-jarslibs.jar.
In order to programmatically access the LexEVS API Grid Service, these libraries need to be added to your local classpath.
...
Example Client and Service Calls and SOAP Messages
See http://gforge.nci.nih.gov/docman/view.php/491/14252/TestClient.zip
Example API Usage
Example 1: Searching for concepts in NCI Thesaurus containing the string "Gene"
Include Page | ||||
---|---|---|---|---|
|
Error Handling
Error Connecting to LexEVS Grid Service
...
If the URL is well-formed, proper connection is tested. If the connection attempt fails, a ConnectException is thrown containing the reason for the failure.
Include Page | ||||
---|---|---|---|---|
|
This example shows a typical connection to the LexEVS Grid Service, with the two potential Exceptions being caught and handled as necessary.
...
- Step 1: Connect to the LexEVS caGrid Service
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url); Step 2:Build an org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.
Code Block CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setName("codingScheme");
Step 3:Build an gov.nih.nci.evs.security.SecurityToken containing the security information for the desired Coding Scheme.
Code Block SecurityToken token = new SecurityToken (); token.setAccessToken("securityToken");
Step 4:Invoke the LexEVS caGrid service as follows: This will return a reference to a new "LexBIGServiceGrid" instance that is associated with the security properties that were passed in.
Code Block LexBIGServiceGrid lbsg = lbs.setSecurityToken(codingScheme, token);
It is important to note that the Grid Service "setSecurityToken" returns an _org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types
.LexEVSGridServiceReference.LexEVSGridServiceReference_ object. This reference must be used to access the secured vocabularies.
Implementation
Each call to "setSecurityToken" sets up a secured connection to Distributed LexEVS with the access privileges included in the SecurityToken parameter. The LexEVSGridServiceReference that is returned to the client contains a unique key identifier to the secure connection that has been created on the server. All subsequent calls the client makes through this LexEVSGridServiceReference will be made securely. If additional SecurityTokens are passed in through the "setSecurityToken" Grid Service, the additional security will be added and maintained.
...
Info | ||
---|---|---|
| ||
All non-secured information accessed by the LexEVS Grid Service is publicly available from NCICB and users are expected to follow the licensing requirements currently in place for accessing and using NCI EVS information. | ||
Wiki Markup |
Scrollbar | ||
---|---|---|
|