org.apache.ambari.server.state

Class UriInfo

java.lang.Object

org.apache.ambari.server.state.UriInfo

public class UriInfo
extends Object

The UriInfo class is used to represent a complex URI structure where there can be both a plaintext and SSL URI. This is used in cases where the alert definition needs a way to expose which URL (http or https) should be used to gather data. Currently, only MetricSource uses this, but it can be swapped out in other source types where a plain string is used for the URI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UriInfo.HighAvailability The UriInfo.HighAvailability structure is used to hold information about how HA URIs are constructed if the service supports HA mode.

Constructor Summary

Constructors

Constructor and Description
UriInfo()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<Integer>	getAcceptableCodes()
int	getConnectionTimeoutMsec()
Number	getDefaultPort() Gets the default port to use on the host running the alert if none of the http properties are available.
UriInfo.HighAvailability	getHighAvailability() Gets the HA structure to use when determining if the component is in HA mode and requires the URL to be built dynamically.
String	getHttpsProperty() The configuration property that can be used to determine if the secure URL should be used.
String	getHttpsPropertyValue() The literal value to use when comparing to the result from getHttpsProperty().
String	getHttpsUri() Gets the secure (HTTPS) URI that can be used to retrieve alert information.
String	getHttpUri() Gets the plaintext (HTTP) URI that can be used to retrieve alert information.
String	getKerberosKeytab() The configuration property with kerberos keytab path.
String	getKerberosPrincipal() The configuration property with kerberos principal name.
int	getReadTimeoutMsec()
int	hashCode()
URI	resolve(Map<String,Map<String,String>> config)
void	setAcceptableCodes(Set<Integer> m_acceptableCodes)
void	setHttpsProperty(String m_httpsProperty)
void	setHttpsPropertyValue(String m_httpsPropertyValue)
void	setHttpsUri(String httpsUri)
void	setHttpUri(String httpUri) Sets the plaintext (HTTP) URI that can be used to retrieve alert information.

Methods inherited from class java.lang.Object

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

Constructor Detail

UriInfo

public UriInfo()

Method Detail

getHttpUri

public String getHttpUri()

Gets the plaintext (HTTP) URI that can be used to retrieve alert information.

Returns:

the httpUri the URI (or null to always use the secure URL).

setHttpUri

public void setHttpUri(String httpUri)

Sets the plaintext (HTTP) URI that can be used to retrieve alert information.

Parameters:

httpUri - the plaintext URI or null for none.

setHttpsUri

public void setHttpsUri(String httpsUri)

setHttpsPropertyValue

public void setHttpsPropertyValue(String m_httpsPropertyValue)

setHttpsProperty

public void setHttpsProperty(String m_httpsProperty)

getDefaultPort

public Number getDefaultPort()

Gets the default port to use on the host running the alert if none of the http properties are available.

Returns:

the default port if none of the http properties are found.

getHttpsUri

public String getHttpsUri()

Gets the secure (HTTPS) URI that can be used to retrieve alert information.

Returns:

the httpsUri the URI (or null to always use the insecure URL).

getHttpsProperty

public String getHttpsProperty()

The configuration property that can be used to determine if the secure URL should be used.

Returns:

the httpsProperty the configuration property, or null for none.

getHttpsPropertyValue

public String getHttpsPropertyValue()

The literal value to use when comparing to the result from getHttpsProperty().

Returns:

the httpsPropertyValue the literal value that indicates SSL mode is enabled, or null for none.

getKerberosKeytab

public String getKerberosKeytab()

The configuration property with kerberos keytab path.

Returns:

the configuration property, or null for none.

getKerberosPrincipal

public String getKerberosPrincipal()

The configuration property with kerberos principal name.

Returns:

the configuration property, or null for none.

getHighAvailability

public UriInfo.HighAvailability getHighAvailability()

Gets the HA structure to use when determining if the component is in HA mode and requires the URL to be built dynamically.

Returns:

the HA structure or null if the component does not support HA mode.

getAcceptableCodes

public Set<Integer> getAcceptableCodes()

setAcceptableCodes

public void setAcceptableCodes(Set<Integer> m_acceptableCodes)

resolve

public URI resolve(Map<String,Map<String,String>> config)
            throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getConnectionTimeoutMsec

public int getConnectionTimeoutMsec()

getReadTimeoutMsec

public int getReadTimeoutMsec()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object