public class BesGatewayApi extends BesApi implements java.lang.Cloneable
ASCII, BES_SERVER_ADMINISTRATOR_KEY, CF_HISTORY_ENTRY_CONTEXT, CLOUDY_DAP_CONTEXT, COVJSON, CSV, DAP2_DATA, DAP4_DATA, DAP4_DMR, DAS, DataDDX, DDS, DDX, DEFAULT_BES_CATALOG_NAME, DEFAULT_BES_CATALOG_TYPE_MATCH_KEY, DEFAULT_BES_CONTAINER, DEFAULT_SUPPORT_EMAIL_ADDRESS, DEFAULT_XDAP_ACCEPT, ERRORS_CONTEXT, EXPLICIT_CONTAINERS_CONTEXT, GEOTIFF, GMLJP2, HTML_FORM, IJSON, INFO_PAGE, JSON, MATCH_LAST_DOT_SUFFIX_REGEX_STRING, MAX_RESPONSE_SIZE_CONTEXT, NETCDF_3, NETCDF_4, REQUEST_ID, SHOW_BES_KEY, STORE_RESULT_CONTEXT, STREAM, SUPPORT_EMAIL, VALUE, W10N, W10N_CALLBACK, W10N_FLATTEN, W10N_META, W10N_TRAVERSE, XDAP_ACCEPT_CONTEXT, XML_DATA, XML_ERRORS, XMLBASE_CONTEXT
Constructor and Description |
---|
BesGatewayApi() |
BesGatewayApi(java.lang.String servicePrefix) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
protected java.lang.String |
getBesContainerName()
This defines the name of the container built by the BES.
|
java.lang.String |
getBesDataSourceID(java.lang.String relativeUrl,
java.util.regex.Pattern suffixMatchPattern,
boolean checkWithBes)
Because the gateway doesn't support a catalog we ignore the checkWithBes parameter
|
void |
getBesNode(java.lang.String dataSource,
org.jdom.Document response)
Returns the BES catalog document for the specified dataSource.
|
void |
getBesNodeDummy(java.lang.String dataSource,
org.jdom.Document response) |
void |
getBesNodeRemote(java.lang.String dataSourceUrl,
org.jdom.Document response) |
protected java.lang.String |
getBesSpaceName()
This method defines which "space" (aka catalog) the BES will use to service the request.
|
org.jdom.Document |
getDap2RequestDocumentAsync(java.lang.String type,
java.lang.String remoteDataSourceUrl,
java.lang.String ce,
java.lang.String async,
java.lang.String storeResult,
java.lang.String xdap_accept,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String formURL,
java.lang.String returnAs,
java.lang.String errorContext)
This child class of opendap.bes.BesXmlAPI provides an implementation of the
getRequestDocument method that utilizes the BES wcs_gateway_module.
|
org.jdom.Document |
getDap4DataRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String contentID,
java.lang.String mimeBoundary)
Returns the DDX request document for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4RequestDocument(java.lang.String type,
java.lang.String remoteDataSourceUrl,
QueryParameters qp,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String formURL,
java.lang.String returnAs,
java.lang.String errorContext) |
java.lang.String |
getRemoteDataSourceUrl(java.lang.String relativeURL,
java.lang.String pathPrefix,
java.util.regex.Pattern suffixMatchPattern) |
org.jdom.Element |
getShowNodeResponseDocForDatasetUrl(java.lang.String dataSourceURL,
int size,
java.util.Date lastModified) |
besTransaction, besTransaction, constraintElement, containerElement, dap4ConstraintElement, dap4FunctionElement, defineElement, getAdminInfo, getAdministrator, getBES, getBesCatalog, getBesCombinedTypeMatch, getBESConfigParameterMap, getBesDataSourceID, getBESprefix, getBesVersion, getCombinedVersionDocument, getDap2DataAsAsciiRequest, getDap2DataAsCovJsonRequest, getDap2DataAsGeoTiffRequest, getDap2DataAsGmlJpeg2000Request, getDap2DataAsJsonRequest, getDap2DataAsNetcdf3Request, getDap2DataAsNetcdf4Request, getDap2DataAsW10nJsonRequest, getDap2IjsnDataRequest, getDap2IjsnMetadataRequest, getDap2MetadataAsJsonRequest, getDap2MetadataAsW10nJsonRequest, getDap2RequestDocument, getDap4DataAsCovJsonRequest, getDap4DataAsCsvRequest, getDap4DataAsGeoTiffRequest, getDap4DataAsGmlJpeg2000Request, getDap4DataAsJsonRequest, getDap4DataAsNetcdf3Request, getDap4DataAsNetcdf4Request, getDap4DataRequest, getDap4IjsnDataRequest, getDap4IjsnMetadataRequest, getDap4JsonMetadataRequest, getDASRequest, getDDSRequest, getDDXDocument, getDDXRequest, getDefaultBesCombinedTypeMatchPattern, getDMRDocument, getDMRRequest, getElement, getElement, getGroupVersionDocument, getHtmlFormRequest, getHtmlInfoPageRequest, getPathInfoDocument, getShowBesKeyRequestDocument, getShowCatalogRequestDocument, getShowInfoRequestDocument, getShowNodeRequestDocument, getShowPathInfoRequestDocument, getShowRequestDocument, getShowVersionRequestDocument, getSiteMapRequestDocument, getSiteMapRequestElement, getStreamRequest, getSupportEmail, getXmlDataRequest, init, isConfigured, isInitialized, setContainerElement, setContextElement, showBesKey, showBesKey, showBesKeyRequestElement, showPathInfoRequestElement, writeCombinedSiteMapResponse, writeDap2Data, writeDap2DataAsAscii, writeDap2DataAsCovJson, writeDap2DataAsGeoTiff, writeDap2DataAsGmlJpeg2000, writeDap2DataAsIjsn, writeDap2DataAsJson, writeDap2DataAsNetcdf3, writeDap2DataAsNetcdf4, writeDap2DataAsW10nJson, writeDap2DataAsXml, writeDap2DataRequestForm, writeDap2HtmlInfoPage, writeDap2MetadataAsIjsn, writeDap2MetadataAsJson, writeDap2MetadataAsW10nJson, writeDap4Data, writeDap4DataAsCovJson, writeDap4DataAsCsv, writeDap4DataAsGeoTiff, writeDap4DataAsGmlJpeg2000, writeDap4DataAsIjsn, writeDap4DataAsJson, writeDap4DataAsNetcdf3, writeDap4DataAsNetcdf4, writeDap4DataAsXml, writeDap4MetadataAsIjsn, writeDap4MetadataAsJson, writeDAS, writeDDS, writeDDX, writeDMR, writeFile, writePathInfoResponse
public BesGatewayApi()
public BesGatewayApi(java.lang.String servicePrefix)
public org.jdom.Document getDap2RequestDocumentAsync(java.lang.String type, java.lang.String remoteDataSourceUrl, java.lang.String ce, java.lang.String async, java.lang.String storeResult, java.lang.String xdap_accept, int maxResponseSize, java.lang.String xmlBase, java.lang.String formURL, java.lang.String returnAs, java.lang.String errorContext) throws BadConfigurationException
getDap2RequestDocumentAsync
in class BesApi
type
- The type of thing being requested. For example a DDX would be
opendap.bes.BesXmlAPI.DDXremoteDataSourceUrl
- See opendap.bes.BesXmlAPI.DDXce
- See opendap.bes.BesXmlAPIxdap_accept
- See opendap.bes.BesXmlAPIxmlBase
- See opendap.bes.BesXmlAPIformURL
- See opendap.bes.BesXmlAPIreturnAs
- See opendap.bes.BesXmlAPIerrorContext
- See opendap.bes.BesXmlAPIBadConfigurationException
- When the bad things happen.
public Document getRequestDocument(String type,
String dataSource,
String ce,
String xdap_accept,
int maxResponseSize,
String xmlBase,
String formURL,
String returnAs,
String errorContext)
throws BadConfigurationException {BesApi
public org.jdom.Document getDap4RequestDocument(java.lang.String type, java.lang.String remoteDataSourceUrl, QueryParameters qp, int maxResponseSize, java.lang.String xmlBase, java.lang.String formURL, java.lang.String returnAs, java.lang.String errorContext) throws BadConfigurationException
getDap4RequestDocument
in class BesApi
BadConfigurationException
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
protected java.lang.String getBesSpaceName()
getBesSpaceName
in class BesApi
protected java.lang.String getBesContainerName()
getBesContainerName
in class BesApi
public java.lang.String getRemoteDataSourceUrl(java.lang.String relativeURL, java.lang.String pathPrefix, java.util.regex.Pattern suffixMatchPattern)
public org.jdom.Document getDap4DataRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize, java.lang.String xmlBase, java.lang.String contentID, java.lang.String mimeBoundary) throws BadConfigurationException
dataSource
- The data set whose DDX is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the dap that should be used to build the
response.xmlBase
- The request URL.contentID
- contentID of the first MIME part.mimeBoundary
- The MIME boundary to use in the response..BadConfigurationException
- When no BES can be found to
service the request.public java.lang.String getBesDataSourceID(java.lang.String relativeUrl, java.util.regex.Pattern suffixMatchPattern, boolean checkWithBes)
getBesDataSourceID
in class BesApi
relativeUrl
- The relative URL of the client request. No Constraint expression (i.e. No query section of
the URL - the question mark and everything after it.)suffixMatchPattern
- This parameter provides the method with a suffix regex to use in evaluating what part,
if any, of the relative URL must be removed to construct the besDataSourceId.checkWithBes
- This boolean value instructs the code to ask the appropriate BES if the resulting
besDataSourceID is does in fact represent a valid data source in it's world. Because the BES gateway_module
doesn't have catalog services this parameter is ignored.public void getBesNode(java.lang.String dataSource, org.jdom.Document response) throws BadConfigurationException, PPTException, org.jdom.JDOMException, java.io.IOException, BESError
BesApi
getBesNode
in class BesApi
dataSource
- The data source whose information is to be retrievedresponse
- The document where the response (be it a catalog
document or an error) will be placed.BadConfigurationException
- .PPTException
- .org.jdom.JDOMException
- .java.io.IOException
- .BESError
public void getBesNodeDummy(java.lang.String dataSource, org.jdom.Document response)
public void getBesNodeRemote(java.lang.String dataSourceUrl, org.jdom.Document response) throws java.io.IOException
java.io.IOException
public org.jdom.Element getShowNodeResponseDocForDatasetUrl(java.lang.String dataSourceURL, int size, java.util.Date lastModified) throws java.io.IOException
java.io.IOException