com.endeca.portal.data.config

Class EndecaServerConfigUtil

java.lang.Object

com.endeca.portal.data.config.EndecaServerConfigUtil

public class EndecaServerConfigUtil
extends java.lang.Object

Singleton class to obtain Endeca Server Info

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ES_DATASET_NAME_PREFIX
static java.lang.String	ES_DATASET_PROJECTS_DELETE_ON_NO_PROJECTS
static java.lang.String	ES_DATASET_PROJECTS_PREFIX
static java.lang.String	ES_HEALTH_CHECK_TIMEOUT
static java.lang.String	ES_INGEST_WS_TIMEOUT
static java.lang.String	ES_NAMESPACE_PREFIX
static java.lang.String	ES_WS_TIMEOUT

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	determineEndecaServerExternalHostName() Tries to determine an externally-resolvable, non-"localhost" hostname for this Studio host.
static long	getActualProjectId(java.lang.String namespacedProjectId) Converts namespaced project id to actual project id.
static java.lang.String	getContextPath()
static java.lang.String	getExternalServer() Returns the Endeca Server hostname to be used when passing configuration to external components, such as DP.
static int	getHealthCheckTimeout()
static int	getIngestWsTimeout()
static java.lang.String	getPort()
static java.lang.String	getProjectNamespace(long projectId) Creates a namespace string by concatenating the optional namespace prefix + _ + project Id.
static java.lang.String	getProjectNamespace(javax.portlet.PortletRequest request) Creates a namespace string based on the current project.
static java.lang.String	getServer() Returns the Endeca Server hostname to be used for direct Web Service calls.
static SSLConfig	getSSLConfig()
static int	getWsTimeout()
static boolean	isDeleteOnNoProjects()
protected static boolean	isLocalhost(java.lang.String hostName)
protected static boolean	isLoopbackOrLocalhost(java.net.InetAddress addr)
static boolean	isProjectMatchesCurrentNamespace(java.lang.String namespacedProjectId) Check if this project belongs to the current environment.
static boolean	isSSLEnabled()
static MDEXState	newMdexState(long groupId, javax.portlet.PortletRequest request) Creates a new MDEXState object for the lone Endeca Server
static MDEXState	newMdexState(javax.portlet.PortletRequest request) Creates a new MDEXState object for the lone Endeca Server
static MDEXState	newMdexState(java.lang.String[] boundDatasets, javax.portlet.PortletRequest request) Creates a new MDEXState object for the lone Dgraph

Methods inherited from class java.lang.Object

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

Field Detail

ES_DATASET_PROJECTS_PREFIX

public static final java.lang.String ES_DATASET_PROJECTS_PREFIX

See Also:

Constant Field Values

ES_DATASET_PROJECTS_DELETE_ON_NO_PROJECTS

public static final java.lang.String ES_DATASET_PROJECTS_DELETE_ON_NO_PROJECTS

See Also:

Constant Field Values

ES_DATASET_NAME_PREFIX

public static final java.lang.String ES_DATASET_NAME_PREFIX

See Also:

Constant Field Values

ES_NAMESPACE_PREFIX

public static final java.lang.String ES_NAMESPACE_PREFIX

See Also:

Constant Field Values

ES_WS_TIMEOUT

public static final java.lang.String ES_WS_TIMEOUT

See Also:

Constant Field Values

ES_INGEST_WS_TIMEOUT

public static final java.lang.String ES_INGEST_WS_TIMEOUT

See Also:

Constant Field Values

ES_HEALTH_CHECK_TIMEOUT

public static final java.lang.String ES_HEALTH_CHECK_TIMEOUT

See Also:

Constant Field Values

Method Detail

getServer

public static java.lang.String getServer()

Returns the Endeca Server hostname to be used for direct Web Service calls. This will be the value of esconfig.properties endeca.server.host if set, otherwise it will be "localhost".

Returns:

the Endeca Server hostname

getExternalServer

public static java.lang.String getExternalServer()

Returns the Endeca Server hostname to be used when passing configuration to external components, such as DP. This will be the value of esconfig.properties endeca.server.host if set, otherwise it will be an external hostname for this Studio host. It will not return "localhost", unless that is the value of endeca.server.host, or Studio was otherwise unable to determine a reasonable external hostname.

Returns:

the Endeca Server hostname

See Also:

getServer()

getPort

public static java.lang.String getPort()

getContextPath

public static java.lang.String getContextPath()

getSSLConfig

public static SSLConfig getSSLConfig()

isSSLEnabled

public static boolean isSSLEnabled()

getWsTimeout

public static int getWsTimeout()

getIngestWsTimeout

public static int getIngestWsTimeout()

getHealthCheckTimeout

public static int getHealthCheckTimeout()

isDeleteOnNoProjects

public static boolean isDeleteOnNoProjects()

newMdexState

public static MDEXState newMdexState(java.lang.String[] boundDatasets,
                     javax.portlet.PortletRequest request)

Creates a new MDEXState object for the lone Dgraph

Parameters:

groupId - project Id for which to create an associated MDEXState

request - current contextual request

Returns:

a new MDEXState

newMdexState

public static MDEXState newMdexState(long groupId,
                     javax.portlet.PortletRequest request)

Creates a new MDEXState object for the lone Endeca Server

Parameters:

groupId - project Id for which to create an associated MDEXState

request - current contextual request

Returns:

a new MDEXState

newMdexState

public static MDEXState newMdexState(javax.portlet.PortletRequest request)

Creates a new MDEXState object for the lone Endeca Server

Parameters:

request - current contextual request (provides current group Id to use for new MDEXState)

Returns:

a new MDEXState

getProjectNamespace

public static java.lang.String getProjectNamespace(javax.portlet.PortletRequest request)

Creates a namespace string based on the current project.

Parameters:

request - Portlet request from within the context of a Studio project.

Returns:

namespace string

See Also:

getProjectNamespace(long)

getProjectNamespace

public static java.lang.String getProjectNamespace(long projectId)

Creates a namespace string by concatenating the optional namespace prefix + _ + project Id. In cases when a namespace prefix is unset, which is expected for a typical topology that does not share the index, only the projectId is returned as the project namespace. It is expected that the caller will append this namespace to a data set key after a delimiter.

Parameters:

projectId - explicit projectId to use when forming the namespace string.

Returns:

namespace string

isProjectMatchesCurrentNamespace

public static boolean isProjectMatchesCurrentNamespace(java.lang.String namespacedProjectId)

Check if this project belongs to the current environment. The namespaced project id is compared with current environment's project namespace

Parameters:

namespacedProjectId -

Returns:

getActualProjectId

public static long getActualProjectId(java.lang.String namespacedProjectId)

Converts namespaced project id to actual project id. Strips out namespace from the string.

Parameters:

namespacedProjectId -

Returns:

determineEndecaServerExternalHostName

public static java.lang.String determineEndecaServerExternalHostName()

Tries to determine an externally-resolvable, non-"localhost" hostname for this Studio host. If all attempts fail, returns "localhost".

Note that this method intentionally avoids reading anything about the HTTP host of the inbound request, which might have been put through a reverse-proxy, or be an otherwise-unsuitable user-facing hostname. Here we want the "internal" hostname, to provide to DP.

This hostname might not always be possible to guess, or guess well, since Studio might be on a multi-homed machine, in which case endeca.server.host should be set in configuration to avoid ambiguity or "localhost".

This method takes this approach:

1. Check the name returned by InetAddress.getLocalHost(). If that address is not localhost and does not represent the local loopback interface, its hostname is returned.
2. Check all local network interfaces, using the same criteria. The first non-localhost non-loopback hostname is returned.
3. If the above searches fail to find a hostname, return "localhost".

Returns:

the externally-addressable hostname determined by scanning network interfaces

isLoopbackOrLocalhost

protected static boolean isLoopbackOrLocalhost(java.net.InetAddress addr)

isLocalhost

protected static boolean isLocalhost(java.lang.String hostName)