com.endeca.portal.data

Class EndecaServerWS

java.lang.Object

com.endeca.portal.data.EndecaServerWS

public class EndecaServerWS
extends java.lang.Object

Singleton object that creates reusable endpoints for each Endeca Server web service API. Relies on configuration from EndecaServerConfigUtil.

Method Summary

Methods

Modifier and Type	Method and Description
static javax.xml.ws.BindingProvider	addQueryTracking(javax.xml.ws.BindingProvider servicePort, RequestIds requestIds) instrument a MDEX 7 query by setting HTTP headers
static java.net.HttpURLConnection	createRawConnection(java.net.URL url, SSLConfig sslConfig, boolean useHealthCheckTimeout)
static com.endeca.endeca_server.cluster.ClusterPort	getClusterPort() Convenience method for getting the cluster service port
static java.lang.String	getClusterServiceURL()
static com.endeca.mdex.config.services.config.ConfigPort	getConfigServicePort() Convenience method for getting the Config service port
static java.lang.String	getConfigServiceURL() This method is only useful when the data source supports the discovery service.
static int	getDataVersion()
static int	getDataVersion(boolean forceRefresh)
static com.endeca.mdex.conversation.ConversationPort	getDiscoveryServicePort() Convenience method for getting the Conversation service port
static java.lang.String	getDiscoveryServiceURL()
static com.endeca.mdex.ingest.IngestPort	getIngestPort() Convenience method for getting the ingest service port
static java.lang.String	getIngestServiceURL()
static com.endeca.mdex.eql_parser.ParserPort	getLQLParserPort() Convenience method for getting the LQL Parser service port
static java.lang.String	getLQLParserServiceURL()
static com.endeca.endeca_server.sconfig.SConfigPort	getSConfigPort() Convenience method for getting the Semantic Config service port
static java.lang.String	getSConfigServiceURL()
static java.lang.String	getServiceURL(java.lang.String service) This method is used to generate URLs for the specified service.
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getTrackingHeaders(RequestIds requestIds) Add sessionId, portletId, gestureId and ecid-context into the request header
static void	setDataVersion(com.endeca.mdex.conversation.ConversationPort servicePort) Extracts latest data version from CS response headers and saves it into this singleton.

Methods inherited from class java.lang.Object

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

Method Detail

getDiscoveryServicePort

public static com.endeca.mdex.conversation.ConversationPort getDiscoveryServicePort()

Convenience method for getting the Conversation service port

getConfigServicePort

public static com.endeca.mdex.config.services.config.ConfigPort getConfigServicePort()
                                                                              throws java.lang.UnsupportedOperationException

Convenience method for getting the Config service port

Throws:

java.lang.UnsupportedOperationException

getSConfigPort

public static com.endeca.endeca_server.sconfig.SConfigPort getSConfigPort()
                                                                   throws DataSourceException

Convenience method for getting the Semantic Config service port

Throws:

DataSourceException

getLQLParserPort

public static com.endeca.mdex.eql_parser.ParserPort getLQLParserPort()
                                                              throws DataSourceException

Convenience method for getting the LQL Parser service port

Throws:

DataSourceException

getIngestPort

public static com.endeca.mdex.ingest.IngestPort getIngestPort()
                                                       throws DataSourceException

Convenience method for getting the ingest service port

Throws:

DataSourceException

getClusterPort

public static com.endeca.endeca_server.cluster.ClusterPort getClusterPort()
                                                                   throws DataSourceException

Convenience method for getting the cluster service port

Throws:

DataSourceException

getDiscoveryServiceURL

public static java.lang.String getDiscoveryServiceURL()

getConfigServiceURL

public static java.lang.String getConfigServiceURL()
                                            throws java.lang.UnsupportedOperationException

This method is only useful when the data source supports the discovery service.

Returns:

the URL of the Conversation Service associated with this data source.

Throws:

java.lang.UnsupportedOperationException

getSConfigServiceURL

public static java.lang.String getSConfigServiceURL()

Returns:

the URL of the Semantic Config Service associated with this data source.

getLQLParserServiceURL

public static java.lang.String getLQLParserServiceURL()

Returns:

the URL of the LQL Parser Service associated with this data source.

getIngestServiceURL

public static java.lang.String getIngestServiceURL()

Returns:

the URL of the data ingest Service associated with this data source.

getClusterServiceURL

public static java.lang.String getClusterServiceURL()

Returns:

the URL of the cluster service associated with this data source.

getServiceURL

public static java.lang.String getServiceURL(java.lang.String service)

This method is used to generate URLs for the specified service.

Returns:

the URL of the Conversation Service associated with this data source.

createRawConnection

public static java.net.HttpURLConnection createRawConnection(java.net.URL url,
                                             SSLConfig sslConfig,
                                             boolean useHealthCheckTimeout)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

setDataVersion

public static void setDataVersion(com.endeca.mdex.conversation.ConversationPort servicePort)

Extracts latest data version from CS response headers and saves it into this singleton. The version number can then be obtained by clients using getDataVersion()

getDataVersion

public static int getDataVersion()

Returns:

the latest data version seen in a CS response.

getDataVersion

public static int getDataVersion(boolean forceRefresh)

Parameters:

forceRefresh - - To fetch the latest version by sending out an empty request and not use cached value

Returns:

the latest data version seen in a CS response.

getTrackingHeaders

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> getTrackingHeaders(RequestIds requestIds)

Add sessionId, portletId, gestureId and ecid-context into the request header

Parameters:

requestIds -

Returns:

addQueryTracking

public static javax.xml.ws.BindingProvider addQueryTracking(javax.xml.ws.BindingProvider servicePort,
                                            RequestIds requestIds)

instrument a MDEX 7 query by setting HTTP headers

Parameters:

servicePort - the BindingProvider for the query

requestIds - the tracker containing the session, request

Returns:

the modified provider