Package edu.sc.seis.seisFile.fdsnws

Class AbstractQueryParams

java.lang.Object

edu.sc.seis.seisFile.fdsnws.AbstractQueryParams

Direct Known Subclasses:

FDSNDataSelectQueryParams, FDSNEventQueryParams, FDSNStationQueryParams, IRISFedCatQueryParams, IRISWSVirtualNetworkQueryParams

public abstract class AbstractQueryParams
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_HOST
static java.lang.String	EARTHSCOPE_HOST
static java.lang.String	FORMAT
static java.lang.String	IRIS_HOST
static java.lang.String	ISC_HOST
static java.lang.String	ISC_MIRROR_HOST
static java.lang.String	NEWLINE
static java.lang.String	NO_DATA
int	nodata
static java.lang.String	USGS_HOST

Constructor Summary

Constructors

Constructor	Description
AbstractQueryParams(java.lang.String host)

Method Summary

Modifier and Type	Method	Description
void	appendToParam(java.lang.String key, java.lang.String value)
void	clear()
void	clearParam(java.lang.String key)
static java.time.format.DateTimeFormatter	createDateFormat()
java.lang.String	createGetParamString()	Creates the query param string from the parameters.
java.net.URI	formURI()	Forms URI, setting query params.
java.net.URI	formURIForPost()	Forms URI, but ignores all query parameters.
java.lang.String	getFDSNMajorVersion()
java.lang.String	getFdsnQueryStyle()
java.lang.String	getFdsnwsPath()
java.lang.String	getHost()
org.apache.hc.core5.http.HttpHost	getHTTPHost()
java.lang.String	getParam(java.lang.String key)
java.util.HashMap<java.lang.String,java.lang.String>	getParams()
int	getPort()
java.lang.String	getScheme()
abstract java.lang.String	getServiceName()	Service name as defined by the fdsn, ie event, station or dataselect.
void	setBaseURL(java.net.URI uri)
void	setFdsnQueryStyle(java.lang.String queryStyle)
void	setFdsnwsPath(java.lang.String fdsnwsPath)
void	setParam(java.lang.String key, boolean value)
void	setParam(java.lang.String key, float value)
void	setParam(java.lang.String key, int value)
void	setParam(java.lang.String key, java.lang.String value)
void	setParam(java.lang.String key, java.time.Instant value)
void	setParam(java.lang.String key, java.time.Instant value, boolean appendZ)
void	setScheme(java.lang.String scheme)	sets the scheme, usually to either http or https.
void	useHTTP()
void	useHTTPS()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodata

public int nodata

NO_DATA

public static final java.lang.String NO_DATA

See Also:

Constant Field Values

IRIS_HOST

public static final java.lang.String IRIS_HOST

See Also:

Constant Field Values

EARTHSCOPE_HOST

public static final java.lang.String EARTHSCOPE_HOST

See Also:

Constant Field Values

USGS_HOST

public static final java.lang.String USGS_HOST

See Also:

Constant Field Values

ISC_HOST

public static final java.lang.String ISC_HOST

See Also:

Constant Field Values

ISC_MIRROR_HOST

public static final java.lang.String ISC_MIRROR_HOST

See Also:

Constant Field Values

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST

See Also:

Constant Field Values

FORMAT

public static final java.lang.String FORMAT

See Also:

Constant Field Values

NEWLINE

public static final java.lang.String NEWLINE

See Also:

Constant Field Values

Constructor Detail

AbstractQueryParams

public AbstractQueryParams(java.lang.String host)

Method Detail

setParam

public void setParam(java.lang.String key,
                     java.lang.String value)

setParam

public void setParam(java.lang.String key,
                     int value)

setParam

public void setParam(java.lang.String key,
                     float value)

setParam

public void setParam(java.lang.String key,
                     boolean value)

appendToParam

public void appendToParam(java.lang.String key,
                          java.lang.String value)

setParam

public void setParam(java.lang.String key,
                     java.time.Instant value)

setParam

public void setParam(java.lang.String key,
                     java.time.Instant value,
                     boolean appendZ)

clearParam

public void clearParam(java.lang.String key)

clear

public void clear()

createDateFormat

public static java.time.format.DateTimeFormatter createDateFormat()

formURI

public java.net.URI formURI()
                     throws java.net.URISyntaxException

Forms URI, setting query params. A URI without query parameters can be created via formURIForPost().

Returns:

uri for query

Throws:

java.net.URISyntaxException

formURIForPost

public java.net.URI formURIForPost()
                            throws java.net.URISyntaxException

Forms URI, but ignores all query parameters. Assumes they will be included in the POST body.

Returns:

uri for POST query

Throws:

java.net.URISyntaxException

createGetParamString

public java.lang.String createGetParamString()
                                      throws java.net.URISyntaxException

Creates the query param string from the parameters.

Returns:

query param string

Throws:

java.net.URISyntaxException

setBaseURL

public void setBaseURL(java.net.URI uri)

getParams

public java.util.HashMap<java.lang.String,java.lang.String> getParams()

setScheme

public void setScheme(java.lang.String scheme)

sets the scheme, usually to either http or https. If the scheme is https and the current port is 80, the port is reset to 443 and vice versa.

Parameters:

scheme - either http or https

useHTTPS

public void useHTTPS()

useHTTP

public void useHTTP()

getScheme

public java.lang.String getScheme()

getPort

public int getPort()

getFdsnwsPath

public java.lang.String getFdsnwsPath()

setFdsnwsPath

public void setFdsnwsPath(java.lang.String fdsnwsPath)

getFdsnQueryStyle

public java.lang.String getFdsnQueryStyle()

setFdsnQueryStyle

public void setFdsnQueryStyle(java.lang.String queryStyle)

getFDSNMajorVersion

public java.lang.String getFDSNMajorVersion()

getServiceName

public abstract java.lang.String getServiceName()

Service name as defined by the fdsn, ie event, station or dataselect.

getHost

public java.lang.String getHost()

getHTTPHost

public org.apache.hc.core5.http.HttpHost getHTTPHost()

getParam

public java.lang.String getParam(java.lang.String key)