public class BesApi
extends java.lang.Object
implements java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ASCII |
static java.lang.String |
BES_SERVER_ADMINISTRATOR_KEY |
static java.lang.String |
CF_HISTORY_ENTRY_CONTEXT |
static java.lang.String |
CLOUDY_DAP_CONTEXT |
static java.lang.String |
COVJSON |
static java.lang.String |
CSV |
static java.lang.String |
DAP2_DATA |
static java.lang.String |
DAP4_DATA |
static java.lang.String |
DAP4_DMR |
static java.lang.String |
DAS |
static java.lang.String |
DataDDX |
static java.lang.String |
DDS |
static java.lang.String |
DDX |
static java.lang.String |
DEFAULT_BES_CATALOG_NAME
This specifies that the default BES "space" name is "catalog".
|
static java.lang.String |
DEFAULT_BES_CATALOG_TYPE_MATCH_KEY |
static java.lang.String |
DEFAULT_BES_CONTAINER
This specifes the sdeafult BES "container" name.
|
static java.lang.String |
DEFAULT_SUPPORT_EMAIL_ADDRESS |
static java.lang.String |
DEFAULT_XDAP_ACCEPT |
static java.lang.String |
ERRORS_CONTEXT |
static java.lang.String |
EXPLICIT_CONTAINERS_CONTEXT |
static java.lang.String |
GEOTIFF |
static java.lang.String |
GMLJP2 |
static java.lang.String |
HTML_FORM |
static java.lang.String |
IJSON |
static java.lang.String |
INFO_PAGE |
static java.lang.String |
JSON |
static java.lang.String |
MATCH_LAST_DOT_SUFFIX_REGEX_STRING |
static java.lang.String |
MAX_RESPONSE_SIZE_CONTEXT |
static java.lang.String |
NETCDF_3 |
static java.lang.String |
NETCDF_4 |
static java.lang.String |
REQUEST_ID |
static java.lang.String |
SHOW_BES_KEY |
static java.lang.String |
STORE_RESULT_CONTEXT |
static java.lang.String |
STREAM |
static java.lang.String |
SUPPORT_EMAIL |
static java.lang.String |
VALUE |
static java.lang.String |
W10N |
static java.lang.String |
W10N_CALLBACK |
static java.lang.String |
W10N_FLATTEN |
static java.lang.String |
W10N_META |
static java.lang.String |
W10N_TRAVERSE |
static java.lang.String |
XDAP_ACCEPT_CONTEXT |
static java.lang.String |
XML_DATA |
static java.lang.String |
XML_ERRORS |
static java.lang.String |
XMLBASE_CONTEXT |
Constructor and Description |
---|
BesApi() |
Modifier and Type | Method and Description |
---|---|
void |
besTransaction(java.lang.String dataSource,
org.jdom.Document request,
org.jdom.Document response)
Executes a command/response transaction with the BES
|
void |
besTransaction(java.lang.String dataSource,
org.jdom.Document request,
java.io.OutputStream os)
Executes a command/response transaction with the BES
|
java.lang.Object |
clone() |
org.jdom.Element |
constraintElement(java.lang.String ce) |
org.jdom.Element |
containerElement(java.lang.String name) |
org.jdom.Element |
dap4ConstraintElement(java.lang.String ce) |
org.jdom.Element |
dap4FunctionElement(java.lang.String dap4_function) |
org.jdom.Element |
defineElement(java.lang.String name,
java.lang.String space) |
AdminInfo |
getAdminInfo(java.lang.String path) |
java.lang.String |
getAdministrator(java.lang.String path)
Returns the Administrator email held by the BES associated with the path.
|
BES |
getBES(java.lang.String dataSource) |
void |
getBesCatalog(java.lang.String dataSource,
org.jdom.Document response)
Deprecated.
|
java.lang.String |
getBesCombinedTypeMatch() |
java.util.HashMap<java.lang.String,java.lang.String> |
getBESConfigParameterMap(java.lang.String besPath,
java.lang.String mapName)
Retrives a BES Key that holds a Map stored in the values of the key and formatted as key:value
|
protected java.lang.String |
getBesContainerName()
This defines the name of the container built by the BES.
|
java.lang.String |
getBesDataSourceID(java.lang.String relativeUrl,
boolean checkWithBes)
The besDataSourceId is the relative (local) URL path of the request, minus any requestSuffixRegex detected.
|
java.lang.String |
getBesDataSourceID(java.lang.String relativeUrl,
java.util.regex.Pattern matchPattern,
boolean checkWithBes)
The besDataSourceId is the relative (local) URL path of the request, minus any requestSuffixRegex detected.
|
void |
getBesNode(java.lang.String dataSource,
org.jdom.Document response)
Returns the BES catalog document for the specified dataSource.
|
java.lang.String |
getBESprefix(java.lang.String dataSource) |
protected java.lang.String |
getBesSpaceName()
This method defines which "space" (aka catalog) the BES will use to service a request.
|
void |
getBesVersion(java.lang.String dataSource,
org.jdom.Document response)
Returns the BES version document for the BES serving the passed
dataSource.
|
org.jdom.Document |
getCombinedVersionDocument() |
org.jdom.Document |
getDap2DataAsAsciiRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize) |
org.jdom.Document |
getDap2DataAsCovJsonRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2DataAsGeoTiffRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2DataAsGmlJpeg2000Request(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2DataAsJsonRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2DataAsNetcdf3Request(java.lang.String dataSource,
java.lang.String ce,
java.lang.String cf_history_entry,
java.lang.String xdap_accept,
int maxResponseSize) |
org.jdom.Document |
getDap2DataAsNetcdf4Request(java.lang.String dataSource,
java.lang.String ce,
java.lang.String cf_history_entry,
java.lang.String xdap_accept,
int maxResponseSize) |
org.jdom.Document |
getDap2DataAsW10nJsonRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String w10nMeta,
java.lang.String w10nCallback,
boolean w10nFlatten,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2IjsnDataRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2IjsnMetadataRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2MetadataAsJsonRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the JSON encoded DAP2 Metadata response (DDX) for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2MetadataAsW10nJsonRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String w10nMeta,
java.lang.String w10nCallback,
boolean w10nFlatten,
boolean w10nTraverse,
java.lang.String xdap_accept,
int maxResponseSize)
Returns the JSON encoded DAP2 Metadata response (DDX) for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap2RequestDocument(java.lang.String type,
java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String formURL,
java.lang.String returnAs,
java.lang.String errorContext)
Returns a BES Request document.
|
org.jdom.Document |
getDap2RequestDocumentAsync(java.lang.String type,
java.lang.String dataSource,
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) |
org.jdom.Document |
getDap4DataAsCovJsonRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4DataAsCsvRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize) |
org.jdom.Document |
getDap4DataAsGeoTiffRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4DataAsGmlJpeg2000Request(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4DataAsJsonRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4DataAsNetcdf3Request(java.lang.String dataSource,
QueryParameters qp,
java.lang.String cf_history_entry,
int maxResponseSize) |
org.jdom.Document |
getDap4DataAsNetcdf4Request(java.lang.String dataSource,
QueryParameters qp,
java.lang.String cf_history_entry,
int maxResponseSize) |
org.jdom.Document |
getDap4DataRequest(java.lang.String dataSource,
QueryParameters qp,
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 |
getDap4IjsnDataRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4IjsnMetadataRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4JsonMetadataRequest(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
org.jdom.Document |
getDap4RequestDocument(java.lang.String type,
java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String formURL,
java.lang.String returnAs,
java.lang.String errorContext) |
org.jdom.Document |
getDASRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept) |
org.jdom.Document |
getDDSRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept)
Returns the DDS request document for the passed dataSource
using the passed constraint expression.
|
void |
getDDXDocument(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
java.lang.String xmlBase,
org.jdom.Document response) |
org.jdom.Document |
getDDXRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
java.lang.String xmlBase)
Returns the DDX request document for the passed dataSource
using the passed constraint expression.
|
java.lang.String |
getDefaultBesCombinedTypeMatchPattern(java.lang.String besPrefix) |
void |
getDMRDocument(java.lang.String dataSource,
QueryParameters qp,
java.lang.String xmlBase,
org.jdom.Document response) |
org.jdom.Document |
getDMRRequest(java.lang.String dataSource,
QueryParameters qp,
java.lang.String xmlBase)
Returns the DDX request document for the passed dataSource
using the passed constraint expression.
|
org.jdom.Element |
getElement(java.lang.String type,
java.lang.String definition,
java.lang.String url,
java.lang.String returnAs) |
org.jdom.Element |
getElement(java.lang.String type,
java.lang.String definition,
java.lang.String url,
java.lang.String returnAs,
java.lang.String async,
java.lang.String storeResult) |
org.jdom.Document |
getGroupVersionDocument(java.lang.String path) |
org.jdom.Document |
getHtmlFormRequest(java.lang.String dataSource,
java.lang.String xdap_accept,
java.lang.String URL) |
org.jdom.Document |
getHtmlInfoPageRequest(java.lang.String dataSource,
java.lang.String xdap_accept) |
void |
getPathInfoDocument(java.lang.String dataSource,
org.jdom.Document response) |
org.jdom.Document |
getShowBesKeyRequestDocument(java.lang.String besKey) |
org.jdom.Document |
getShowCatalogRequestDocument(java.lang.String dataSource)
Deprecated.
|
org.jdom.Document |
getShowInfoRequestDocument(java.lang.String dataSource) |
org.jdom.Document |
getShowNodeRequestDocument(java.lang.String dataSource) |
org.jdom.Document |
getShowPathInfoRequestDocument(java.lang.String dataSource) |
org.jdom.Document |
getShowRequestDocument(java.lang.String type,
java.lang.String dataSource) |
org.jdom.Document |
getShowVersionRequestDocument() |
org.jdom.Document |
getSiteMapRequestDocument(java.lang.String sitePrefix) |
org.jdom.Element |
getSiteMapRequestElement(java.lang.String prefix,
java.lang.String nodeSuffix,
java.lang.String leafSuffix)
|
org.jdom.Document |
getStreamRequest(java.lang.String dataSource) |
java.lang.String |
getSupportEmail(java.lang.String path)
Returns the support email held by the BES associated with the path.
|
org.jdom.Document |
getXmlDataRequest(java.lang.String dataSource,
java.lang.String ce,
java.lang.String xdap_accept,
int maxResponseSize,
java.lang.String xmlBase)
Returns the XML data response for the passed dataSource
using the passed constraint expression.
|
void |
init()
Initializes logging for the BesApi class.
|
boolean |
isConfigured() |
boolean |
isInitialized() |
org.jdom.Element |
setContainerElement(java.lang.String name,
java.lang.String space,
java.lang.String source,
java.lang.String type) |
org.jdom.Element |
setContextElement(java.lang.String name,
java.lang.String value) |
org.jdom.Element |
showBesKey(java.lang.String besKey) |
org.jdom.Element |
showBesKey(java.lang.String besPrefix,
java.lang.String besKey) |
org.jdom.Element |
showBesKeyRequestElement(java.lang.String besKey) |
org.jdom.Element |
showPathInfoRequestElement(java.lang.String resource) |
void |
writeCombinedSiteMapResponse(java.lang.String sitePrefix,
java.io.OutputStream os)
Writes the combined site map for the server to the passed stream.
|
void |
writeDap2Data(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String async,
java.lang.String storeResult,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes an OPeNDAP DAP2 data response for the dataSource to the
passed stream.
|
void |
writeDap2DataAsAscii(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the ASCII representation _rawOS the OPeNDAP data response for the
dataSource to the passed stream.
|
void |
writeDap2DataAsCovJson(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP2 CovJSON data response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsGeoTiff(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsGmlJpeg2000(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsIjsn(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP2 IJson data response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsJson(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP2 JSON data response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsNetcdf3(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String cf_history_entry,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF-3 file out response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsNetcdf4(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String cf_history_entry,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF-4 file out response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsW10nJson(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String w10nMeta,
java.lang.String w10nCallback,
boolean w10nFlatten,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the w10n Json response for the dataSource to the passed
stream.
|
void |
writeDap2DataAsXml(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.lang.String xmlBase,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap2DataRequestForm(java.lang.String dataSource,
java.lang.String xdap_accept,
java.lang.String url,
java.io.OutputStream os)
Writes the HTML data request form (aka the I.F.H.) for the OPeNDAP the
dataSource to the passed stream.
|
void |
writeDap2HtmlInfoPage(java.lang.String dataSource,
java.lang.String xdap_accept,
java.io.OutputStream os)
Writes the OPeNDAP INFO response for the dataSource to the passed
stream.
|
void |
writeDap2MetadataAsIjsn(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP2 IJson metadata response for the dataSource to the passed
stream.
|
void |
writeDap2MetadataAsJson(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Write DAP2 metadata as JSON for the dataSource to the passed
stream.
|
void |
writeDap2MetadataAsW10nJson(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String w10nMeta,
java.lang.String w10nCallback,
boolean w10nFlatten,
boolean w10nTraverse,
java.lang.String xdap_accept,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4Data(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.lang.String xmlBase,
java.lang.String contentID,
java.lang.String mimeBoundary,
java.io.OutputStream os)
Writes an OPeNDAP DAP4 Data response for the dataSource to the passed stream.
|
void |
writeDap4DataAsCovJson(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsCsv(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the ASCII representation _rawOS the OPeNDAP data response for the
dataSource to the passed stream.
|
void |
writeDap4DataAsGeoTiff(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsGmlJpeg2000(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsIjsn(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsJson(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsNetcdf3(java.lang.String dataSource,
QueryParameters qp,
java.lang.String cf_history_entry,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF-3 file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsNetcdf4(java.lang.String dataSource,
QueryParameters qp,
java.lang.String cf_history_entry,
int maxResponseSize,
java.io.OutputStream os)
Writes the NetCDF-4 file out response for the dataSource to the passed
stream.
|
void |
writeDap4DataAsXml(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.lang.String xmlBase,
java.io.OutputStream os)
Writes the DAP4 XML data response for the dataSource to the passed
stream.
|
void |
writeDap4MetadataAsIjsn(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP4 IJson metadata response for the dataSource to the passed
stream.
|
void |
writeDap4MetadataAsJson(java.lang.String dataSource,
QueryParameters qp,
int maxResponseSize,
java.io.OutputStream os)
Writes the DAP4 json metadata response for the dataSource to the passed
stream.
|
void |
writeDAS(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
java.io.OutputStream os)
Writes an OPeNDAP DAS for the dataSource to the passed stream.
|
void |
writeDDS(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
java.io.OutputStream os)
Writes an OPeNDAP DDS for the dataSource to the passed stream.
|
void |
writeDDX(java.lang.String dataSource,
java.lang.String constraintExpression,
java.lang.String xdap_accept,
java.lang.String xmlBase,
java.io.OutputStream os)
Writes an OPeNDAP DDX for the dataSource to the passed stream.
|
void |
writeDMR(java.lang.String dataSource,
QueryParameters qp,
java.lang.String xmlBase,
java.io.OutputStream os)
Writes an OPeNDAP DAP4 DMR for the dataSource to the passed stream.
|
void |
writeFile(java.lang.String dataSource,
java.io.OutputStream os)
Writes the source data (it is often a file, thus the method name) to
the passed stream.
|
void |
writePathInfoResponse(java.lang.String dataSource,
java.io.OutputStream os)
Writes the NetCDF file out response for the dataSource to the passed
stream.
|
public static final java.lang.String DAP4_DATA
public static final java.lang.String DAP4_DMR
public static final java.lang.String DDS
public static final java.lang.String DAS
public static final java.lang.String DDX
public static final java.lang.String DataDDX
public static final java.lang.String DAP2_DATA
public static final java.lang.String STREAM
public static final java.lang.String ASCII
public static final java.lang.String CSV
public static final java.lang.String HTML_FORM
public static final java.lang.String INFO_PAGE
public static final java.lang.String XML_DATA
public static final java.lang.String NETCDF_3
public static final java.lang.String NETCDF_4
public static final java.lang.String GEOTIFF
public static final java.lang.String GMLJP2
public static final java.lang.String JSON
public static final java.lang.String COVJSON
public static final java.lang.String IJSON
public static final java.lang.String W10N
public static final java.lang.String W10N_META
public static final java.lang.String W10N_CALLBACK
public static final java.lang.String W10N_FLATTEN
public static final java.lang.String W10N_TRAVERSE
public static final java.lang.String SHOW_BES_KEY
public static final java.lang.String VALUE
public static final java.lang.String SUPPORT_EMAIL
public static final java.lang.String DEFAULT_SUPPORT_EMAIL_ADDRESS
public static final java.lang.String REQUEST_ID
public static final java.lang.String ERRORS_CONTEXT
public static final java.lang.String XML_ERRORS
public static final java.lang.String XMLBASE_CONTEXT
public static final java.lang.String STORE_RESULT_CONTEXT
public static final java.lang.String XDAP_ACCEPT_CONTEXT
public static final java.lang.String DEFAULT_XDAP_ACCEPT
public static final java.lang.String EXPLICIT_CONTAINERS_CONTEXT
public static final java.lang.String CLOUDY_DAP_CONTEXT
public static final java.lang.String MAX_RESPONSE_SIZE_CONTEXT
public static final java.lang.String CF_HISTORY_ENTRY_CONTEXT
public static final java.lang.String DEFAULT_BES_CATALOG_NAME
public static final java.lang.String DEFAULT_BES_CATALOG_TYPE_MATCH_KEY
public static final java.lang.String DEFAULT_BES_CONTAINER
public static final java.lang.String MATCH_LAST_DOT_SUFFIX_REGEX_STRING
public static final java.lang.String BES_SERVER_ADMINISTRATOR_KEY
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public void init()
public boolean isInitialized()
public boolean isConfigured()
public org.jdom.Document getGroupVersionDocument(java.lang.String path) throws java.lang.Exception
java.lang.Exception
public org.jdom.Document getCombinedVersionDocument() throws java.lang.Exception
java.lang.Exception
public AdminInfo getAdminInfo(java.lang.String path) throws org.jdom.JDOMException, BadConfigurationException, PPTException, BESError, java.io.IOException
org.jdom.JDOMException
BadConfigurationException
PPTException
BESError
java.io.IOException
public java.lang.String getAdministrator(java.lang.String path) throws BadConfigurationException, org.jdom.JDOMException, java.io.IOException, PPTException, BESError
path
- BadConfigurationException
org.jdom.JDOMException
java.io.IOException
PPTException
BESError
public java.lang.String getSupportEmail(java.lang.String path)
path
- public void writeDDX(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, java.lang.String xmlBase, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.xmlBase
- The request URL.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDMR(java.lang.String dataSource, QueryParameters qp, java.lang.String xmlBase, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parameters associated with the request.xmlBase
- The request URL.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4Data(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.lang.String xmlBase, java.lang.String contentID, java.lang.String mimeBoundary, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- A DAP4 QueryParameters object generated by processing the requestxmlBase
- The request URL.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void getDDXDocument(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, java.lang.String xmlBase, org.jdom.Document response) throws PPTException, BadConfigurationException, java.io.IOException, org.jdom.JDOMException, BESError
PPTException
BadConfigurationException
java.io.IOException
org.jdom.JDOMException
BESError
public void getDMRDocument(java.lang.String dataSource, QueryParameters qp, java.lang.String xmlBase, org.jdom.Document response) throws PPTException, BadConfigurationException, java.io.IOException, org.jdom.JDOMException, BESError
dataSource
- The requested DataSourceqp
- The DAP4 query parametersxmlBase
- The request URL.response
- PPTException
BadConfigurationException
java.io.IOException
org.jdom.JDOMException
BESError
public void writeDDS(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request.xdap_accept
- The version of the DAP the BES is to use to package the
reponse.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeFile(java.lang.String dataSource, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDAS(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2Data(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String async, java.lang.String storeResult, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsNetcdf3(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String cf_history_entry, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..cf_history_entry
- The entry to add to the CF "history" attribute in the resulting NetCDF file..xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsNetcdf3(java.lang.String dataSource, QueryParameters qp, java.lang.String cf_history_entry, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsNetcdf4(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String cf_history_entry, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsNetcdf4(java.lang.String dataSource, QueryParameters qp, java.lang.String cf_history_entry, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsXml(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.lang.String xmlBase, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.xmlBase
- The request URL.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsGmlJpeg2000(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsGmlJpeg2000(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsJson(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsCovJson(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeCombinedSiteMapResponse(java.lang.String sitePrefix, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
sitePrefix
- The requested DataSourceos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writePathInfoResponse(java.lang.String dataSource, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void getPathInfoDocument(java.lang.String dataSource, org.jdom.Document response) throws PPTException, BadConfigurationException, java.io.IOException, org.jdom.JDOMException, BESError
PPTException
BadConfigurationException
java.io.IOException
org.jdom.JDOMException
BESError
public void writeDap4DataAsGeoTiff(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsIjsn(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersos
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsXml(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.lang.String xmlBase, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parametersxmlBase
- The request URL.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4MetadataAsJson(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query parameters submitted with the request.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4MetadataAsIjsn(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query parameters submitted with the request.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsIjsn(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2MetadataAsIjsn(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsJson(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsCovJson(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2MetadataAsJson(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsW10nJson(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String w10nMeta, java.lang.String w10nCallback, boolean w10nFlatten, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2MetadataAsW10nJson(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String w10nMeta, java.lang.String w10nCallback, boolean w10nFlatten, boolean w10nTraverse, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsGeoTiff(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataAsAscii(java.lang.String dataSource, java.lang.String constraintExpression, java.lang.String xdap_accept, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceconstraintExpression
- The constraintElement expression to be applied to
the request..xdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap4DataAsCsv(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourceqp
- The DAP4 query string parameters associated with the request.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void writeDap2DataRequestForm(java.lang.String dataSource, java.lang.String xdap_accept, java.lang.String url, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourcexdap_accept
- The version of the DAP to use in building the response.url
- The URL to refernence in the HTML form.os
- The Stream to which to write the response.BadConfigurationException
- .PPTException
- .java.io.IOException
- .BESError
- .public void writeDap2HtmlInfoPage(java.lang.String dataSource, java.lang.String xdap_accept, java.io.OutputStream os) throws BadConfigurationException, BESError, java.io.IOException, PPTException
dataSource
- The requested DataSourcexdap_accept
- The version of the DAP to use in building the response.os
- The Stream to which to write the response.BadConfigurationException
- .BESError
- .java.io.IOException
- .PPTException
- .public void getBesVersion(java.lang.String dataSource, org.jdom.Document response) throws PPTException, BadConfigurationException, java.io.IOException, org.jdom.JDOMException, BESError
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.
while servicing the request.PPTException
- .BadConfigurationException
- .java.io.IOException
- .org.jdom.JDOMException
- .BESError
- .@Deprecated public void getBesCatalog(java.lang.String dataSource, org.jdom.Document response) throws BadConfigurationException, PPTException, org.jdom.JDOMException, java.io.IOException, BESError
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.PPTException
- .BadConfigurationException
- .java.io.IOException
- .org.jdom.JDOMException
- .BESError
public void getBesNode(java.lang.String dataSource, org.jdom.Document response) throws BadConfigurationException, PPTException, org.jdom.JDOMException, java.io.IOException, BESError
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.PPTException
- .BadConfigurationException
- .java.io.IOException
- .org.jdom.JDOMException
- .BESError
public void besTransaction(java.lang.String dataSource, org.jdom.Document request, org.jdom.Document response) throws java.io.IOException, PPTException, BadConfigurationException, org.jdom.JDOMException, BESError
dataSource
- The BES datasource that is going to be acccessed. This is used to determine which BES should
be used to fulfill the request (In the event that Hyrax is configured to use multiple BESs this string will
be used to locate the appropriate BES).request
- The BES request document.response
- The document into which the BES response will be placed. If the passed Document object contains
content, then the content will be discarded.java.io.IOException
PPTException
BadConfigurationException
org.jdom.JDOMException
BESError
public void besTransaction(java.lang.String dataSource, org.jdom.Document request, java.io.OutputStream os) throws BadConfigurationException, java.io.IOException, PPTException, BESError
dataSource
- The BES datasource that is going to be acccessed. This is used to determine which BES should
be used to fulfill the request (In the event that Hyrax is configured to use multiple BESs this string will
be used to locate the appropriate BES).request
- The BES request document.os
- The outputstream to write the BES response to.
any error information will be written to the OutputStream err.BadConfigurationException
java.io.IOException
PPTException
BESError
public org.jdom.Element setContainerElement(java.lang.String name, java.lang.String space, java.lang.String source, java.lang.String type)
public org.jdom.Element defineElement(java.lang.String name, java.lang.String space)
public org.jdom.Element containerElement(java.lang.String name)
public org.jdom.Element constraintElement(java.lang.String ce)
public org.jdom.Element dap4ConstraintElement(java.lang.String ce)
public org.jdom.Element dap4FunctionElement(java.lang.String dap4_function)
public org.jdom.Element getElement(java.lang.String type, java.lang.String definition, java.lang.String url, java.lang.String returnAs)
public org.jdom.Element getElement(java.lang.String type, java.lang.String definition, java.lang.String url, java.lang.String returnAs, java.lang.String async, java.lang.String storeResult)
public org.jdom.Element setContextElement(java.lang.String name, java.lang.String value)
public org.jdom.Document getDDXRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, java.lang.String xmlBase) 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.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDMRRequest(java.lang.String dataSource, QueryParameters qp, java.lang.String xmlBase) throws BadConfigurationException
dataSource
- The data set whose DDX is being requestedqp
- The DAP4 query string parameters associated wih the request..
response.xmlBase
- The request URL.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4DataRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.lang.String xmlBase, java.lang.String contentID, java.lang.String mimeBoundary) throws BadConfigurationException
dataSource
- The data set whose DDX is being requestedqp
- The DAP4 QueryParameters ingested from the client request.
response.xmlBase
- The request URL.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDDSRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDASRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap2DataAsAsciiRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap4DataAsCsvRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getHtmlFormRequest(java.lang.String dataSource, java.lang.String xdap_accept, java.lang.String URL) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getStreamRequest(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getHtmlInfoPageRequest(java.lang.String dataSource, java.lang.String xdap_accept) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap2DataAsNetcdf3Request(java.lang.String dataSource, java.lang.String ce, java.lang.String cf_history_entry, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap4DataAsNetcdf3Request(java.lang.String dataSource, QueryParameters qp, java.lang.String cf_history_entry, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap2DataAsNetcdf4Request(java.lang.String dataSource, java.lang.String ce, java.lang.String cf_history_entry, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getDap4DataAsNetcdf4Request(java.lang.String dataSource, QueryParameters qp, java.lang.String cf_history_entry, int maxResponseSize) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getXmlDataRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize, java.lang.String xmlBase) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2DataAsGmlJpeg2000Request(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2DataAsGeoTiffRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4DataAsGeoTiffRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4DataAsGmlJpeg2000Request(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2DataAsJsonRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2DataAsCovJsonRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2MetadataAsJsonRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The DAP2 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2DataAsW10nJsonRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String w10nMeta, java.lang.String w10nCallback, boolean w10nFlatten, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2MetadataAsW10nJsonRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String w10nMeta, java.lang.String w10nCallback, boolean w10nFlatten, boolean w10nTraverse, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The DAP2 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4DataAsJsonRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4DataAsCovJsonRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4IjsnDataRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4JsonMetadataRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap4IjsnMetadataRequest(java.lang.String dataSource, QueryParameters qp, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedqp
- The DAP4 query string parameters associated wih the request.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2IjsnDataRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2IjsnMetadataRequest(java.lang.String dataSource, java.lang.String ce, java.lang.String xdap_accept, int maxResponseSize) throws BadConfigurationException
dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.BadConfigurationException
- When no BES can be found to
service the request.public org.jdom.Document getDap2RequestDocument(java.lang.String type, java.lang.String dataSource, java.lang.String ce, 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
type
- dataSource
- The data set whose DDS is being requestedce
- The constraint expression to apply.xdap_accept
- The version of the DAP to use in building the response.maxResponseSize
- Maximum allowable response size.xmlBase
- formURL
- returnAs
- errorContext
- BadConfigurationException
public org.jdom.Document getDap2RequestDocumentAsync(java.lang.String type, java.lang.String dataSource, 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
BadConfigurationException
protected java.lang.String getBesSpaceName()
protected java.lang.String getBesContainerName()
public org.jdom.Document getDap4RequestDocument(java.lang.String type, java.lang.String dataSource, QueryParameters qp, int maxResponseSize, java.lang.String xmlBase, java.lang.String formURL, java.lang.String returnAs, java.lang.String errorContext) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getSiteMapRequestDocument(java.lang.String sitePrefix)
public org.jdom.Element getSiteMapRequestElement(java.lang.String prefix, java.lang.String nodeSuffix, java.lang.String leafSuffix)
prefix
- public org.jdom.Document getShowPathInfoRequestDocument(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public org.jdom.Element showPathInfoRequestElement(java.lang.String resource)
public org.jdom.Document getShowVersionRequestDocument() throws BadConfigurationException
BadConfigurationException
@Deprecated public org.jdom.Document getShowCatalogRequestDocument(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getShowNodeRequestDocument(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getShowInfoRequestDocument(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public org.jdom.Document getShowRequestDocument(java.lang.String type, java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public BES getBES(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public java.lang.String getBESprefix(java.lang.String dataSource) throws BadConfigurationException
BadConfigurationException
public java.lang.String getBesDataSourceID(java.lang.String relativeUrl, boolean checkWithBes)
Examples:
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.)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.public java.lang.String getBesDataSourceID(java.lang.String relativeUrl, java.util.regex.Pattern matchPattern, boolean checkWithBes)
Examples:
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.)matchPattern
- This parameter provides the method with a regex to us 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.public java.lang.String getBesCombinedTypeMatch() throws org.jdom.JDOMException, BadConfigurationException, PPTException, java.io.IOException, BESError
org.jdom.JDOMException
BadConfigurationException
PPTException
java.io.IOException
BESError
public java.util.HashMap<java.lang.String,java.lang.String> getBESConfigParameterMap(java.lang.String besPath, java.lang.String mapName) throws BadConfigurationException, org.jdom.JDOMException, java.io.IOException, PPTException, BESError
besPath
- mapName
- BadConfigurationException
org.jdom.JDOMException
java.io.IOException
PPTException
BESError
public java.lang.String getDefaultBesCombinedTypeMatchPattern(java.lang.String besPrefix) throws org.jdom.JDOMException, BadConfigurationException, PPTException, BESError, java.io.IOException
org.jdom.JDOMException
BadConfigurationException
PPTException
BESError
java.io.IOException
public org.jdom.Element showBesKey(java.lang.String besKey) throws org.jdom.JDOMException, BadConfigurationException, PPTException, java.io.IOException, BESError
org.jdom.JDOMException
BadConfigurationException
PPTException
java.io.IOException
BESError
public org.jdom.Element showBesKey(java.lang.String besPrefix, java.lang.String besKey) throws org.jdom.JDOMException, BadConfigurationException, PPTException, BESError, java.io.IOException
org.jdom.JDOMException
BadConfigurationException
PPTException
BESError
java.io.IOException
public org.jdom.Document getShowBesKeyRequestDocument(java.lang.String besKey)
public org.jdom.Element showBesKeyRequestElement(java.lang.String besKey)