com.sap.cloud.server.odata.http

Class HttpDestination

java.lang.Object

com.sap.cloud.server.odata.http.HttpDestination

public class HttpDestination
extends java.lang.Object

Encapsulates an HTTP destination that is configured in the execution environment.

Method Summary

Modifier and Type	Method and Description
void	addAuthenticationHeaders(DataServlet servlet, org.apache.http.HttpRequest request) If this destination is pre-configured for HTTP authentication, then add the Authorization header (or other appropriate headers) to the outgoing request.
java.lang.String	getBearerToken()
org.apache.http.client.HttpClient	getHttpClient()
java.lang.String	getName()
java.lang.String	getPassword()
StringMap	getProperties()
java.lang.String	getURL()
java.lang.String	getUsername()
boolean	hasBasicAuthentication()
boolean	hasBearerToken()
static HttpDestination	lookup(java.lang.String name) Lookup a pre-configured HTTP destination.
static void	register(java.lang.String name, HttpDestination destination) Register a pre-configured HTTP destination.
void	setHttpClient(org.apache.http.client.HttpClient client) Set the HTTP client to be used for this destination.

Methods inherited from class java.lang.Object

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

Method Detail

lookup

public static HttpDestination lookup(java.lang.String name)

Lookup a pre-configured HTTP destination.

Parameters:

name - HTP destination name, e.g. "MyBackend".

Returns:

HTTP destination.

register

public static void register(java.lang.String name,
                            HttpDestination destination)

Register a pre-configured HTTP destination.

Parameters:

name - HTP destination name, e.g. "MyBackend".

destination - HTTP destination.

getName

public java.lang.String getName()

Returns:

Destination name.

getProperties

public StringMap getProperties()

Returns:

Destination properties (as returned by destination service, if applicable).

getURL

public java.lang.String getURL()

Returns:

Destination root URL.

getUsername

public java.lang.String getUsername()

Returns:

Destination username for HTTP authentication (if any), otherwise null.

getPassword

public java.lang.String getPassword()

Returns:

Destination password for HTTP authentication (if any), otherwise null.

getBearerToken

public java.lang.String getBearerToken()

Returns:

Bearer token for HTTP authentication (if any), otherwise null.

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Returns:

HTTP client for communicating with the destination.

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient client)

Set the HTTP client to be used for this destination. This is optional, as every destination will have a default HTTP client. Setting the HTTP client may be required if connectivity via a proxy is required.

Parameters:

client - HTTP client.

hasBasicAuthentication

public boolean hasBasicAuthentication()

Returns:

True if the destination is configured for basic authentication, false otherwise.

hasBearerToken

public boolean hasBearerToken()

Returns:

True if the destination is configured to return a Bearer token, false otherwise.

addAuthenticationHeaders

public void addAuthenticationHeaders(DataServlet servlet,
                                     org.apache.http.HttpRequest request)

If this destination is pre-configured for HTTP authentication, then add the Authorization header (or other appropriate headers) to the outgoing request. Otherwise do nothing.

Parameters:

servlet - Data servlet.

request - HTTP request.