GNDMS 0.6.0
RESTful verison of GNDMS
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions

de.zib.gndms.common.rest.GNDMSResponseHeader Class Reference

A class for the generic Http response-header specified for GNDMS. More...

Inherits org::springframework::http::HttpHeaders.

List of all members.

Public Member Functions

 GNDMSResponseHeader ()
 The constructor.
 GNDMSResponseHeader (final String resourceURL, final String facetURL, final String parentURL, final String dn, final String wid)
 The constructor setting the given fields.
 GNDMSResponseHeader (final HttpHeaders h)
 The constructor, setting the given http headers.
final List< String > getResourceURL ()
 Returns the resource url.
final void setResourceURL (final String resourceURL)
 Sets a unique resource url.
final List< String > getFacetURL ()
 Returns the facet url.
final void setFacetURL (final String facetURL)
 Sets a unique facet url.
final List< String > getParentURL ()
 Returns the parent url.
final void setParentURL (final String parentURL)
 Adds a unique parent url.
final List< String > getDN ()
 Returns the dn.
final void setDN (final String dn)
 Adds a unique dn.
final List< String > getWId ()
 Returns the wid.
final void setWId (final String wid)
 Adds a unique wid.
final void addMyProxyToken (@NotNull String purpose,@NotNull String login, String passwd)
 Adds a MyProxy access token to the request header.
final void addMyProxyToken (@NotNull String purpose,@NotNull MyProxyToken token)
final Map< String, MyProxyTokengetMyProxyToken ()

Static Public Member Functions

static Map< String, MyProxyTokenextractTokenFromMap (final MultiValueMap< String, String > context)

Static Public Attributes

static final String MY_PROXY_TOKEN_PREFIX = "myproxytoken-"
static final String MY_PROXY_LOGIN_PREFIX = "-login-"
static final String MY_PROXY_PASSWORD_PREFIX = "-passwd-"
static final String RESOURCE_URL = "resourceURL"
 The key for a resource url.
static final String FACET_URL = "facetURL"
 The key for a facet url.
static final String PARENT_URL = "parentURL"
 The key for a parent url.
static final String DN = "DN"
 The key for a dn.
static final String WID = "WId"
 The key for a wid.

Private Member Functions

void setOnce (String key, String val)

Static Private Member Functions

static String extractPasswordForPurpose (final MultiValueMap< String, String > context, final String purpose)
static String extractLoginName (final MultiValueMap< String, String > context, final String key)
static boolean hasPasswordKeyForPurpose (final MultiValueMap< String, String > context, final String purpose)
static String extractPurposeFromLoginKey (final String key)
static boolean isMyProxyLoginEntryKey (final String key)

Detailed Description

A class for the generic Http response-header specified for GNDMS.

Author:
try ma ik jo rr a zib
Version:
$Id$

Date: 26.01.11, Time: 14:25


Constructor & Destructor Documentation

de.zib.gndms.common.rest.GNDMSResponseHeader.GNDMSResponseHeader ( final String  resourceURL,
final String  facetURL,
final String  parentURL,
final String  dn,
final String  wid 
)

The constructor setting the given fields.

Parameters:
resourceURLThe resource url.
facetURLThe facet url.
parentURLThe parent url.
dnThe dn.
widThe wid.
de.zib.gndms.common.rest.GNDMSResponseHeader.GNDMSResponseHeader ( final HttpHeaders  h)

The constructor, setting the given http headers.

Parameters:
hThe http headers.

Member Function Documentation

final void de.zib.gndms.common.rest.GNDMSResponseHeader.addMyProxyToken ( @NotNull String  purpose,
@NotNull String  login,
String  passwd 
)

Adds a MyProxy access token to the request header.

Parameters:
purposeA keyword describing what this token is required for, e.g. C3GRID or ESGF...
loginThe login string for the MyProxy server.
passwdA password for the MyProxy server, might be omitted for passwordless access.
final List<String> de.zib.gndms.common.rest.GNDMSResponseHeader.getDN ( )

Returns the dn.

Returns:
A list containing the dn.
final List<String> de.zib.gndms.common.rest.GNDMSResponseHeader.getFacetURL ( )

Returns the facet url.

Returns:
A list containing the facet url.
final List<String> de.zib.gndms.common.rest.GNDMSResponseHeader.getParentURL ( )

Returns the parent url.

Returns:
A list containing the parent url.
final List<String> de.zib.gndms.common.rest.GNDMSResponseHeader.getResourceURL ( )

Returns the resource url.

Returns:
A list containing the resource url.
final List<String> de.zib.gndms.common.rest.GNDMSResponseHeader.getWId ( )

Returns the wid.

Returns:
A list containing the wid.
final void de.zib.gndms.common.rest.GNDMSResponseHeader.setDN ( final String  dn)

Adds a unique dn.

Parameters:
dnThe dn.
final void de.zib.gndms.common.rest.GNDMSResponseHeader.setFacetURL ( final String  facetURL)

Sets a unique facet url.

Parameters:
facetURLThe facet url.
final void de.zib.gndms.common.rest.GNDMSResponseHeader.setParentURL ( final String  parentURL)

Adds a unique parent url.

Parameters:
parentURLThe parent url.
final void de.zib.gndms.common.rest.GNDMSResponseHeader.setResourceURL ( final String  resourceURL)

Sets a unique resource url.

Parameters:
resourceURLThe resource url.
final void de.zib.gndms.common.rest.GNDMSResponseHeader.setWId ( final String  wid)

Adds a unique wid.

Parameters:
widThe wid.

The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations