com.softwareag.mobile.runtime.toolkit.rest

Class Credentials

java.lang.Object

com.softwareag.mobile.runtime.toolkit.rest.Credentials

public class Credentials
extends java.lang.Object

Stores user and password data for HTTP requests, including additional security restrictions. Credentials. Before submitted to a HTTP backend service, the securtiy restrictions set for the Credentials will be validated to ensure it's only used within the requested context. Credentials are used in the shared Session and will be added to AbstractRestOperations if all of the following restrictions (if set) apply:

• realm
• hostname
• protocol

You can add multiple realms, hostnames and protocols. If no restriction is set, the Credentials might apply to all URLs.

Version:

9.8.0.0000-0080

Constructor Summary

Constructors

Constructor and Description
Credentials(java.lang.String username, java.lang.String password) Creates new Credentials with the given username and password without any restrictions initially set up.

Method Summary

Modifier and Type	Method and Description
void	addHostname(java.lang.String hostname) Adds a new hostname as additional security restriction.
void	addProtocol(java.lang.String protocol) Adds a protocol as additional security restriction.
void	addRealm(java.lang.String realm) Adds a realm as additional security restriction.
java.util.Vector	getHostnames() Returns all hostnames added as restrictions to this Credentials.
java.lang.String	getPassword() Returns the password stored in the Credentials.
java.util.Vector	getProtocols() Returns all protocols added as restrictions to this Credentials.
java.util.Vector	getRealms() Returns all realms added as restrictions to this Credentials .
java.lang.String	getUsername() Returns the username stored in the Credentials.
boolean	matchesURL(java.lang.String url) Checks if a given URL matches the hostnames and protocols set as restrictions using addHostname(String) and addProtocol(String).
boolean	matchesURL(java.lang.String url, java.lang.String realm) Checks if the given URL and realm match the hostnames, protocols and realms set as restrictions using addHostname(String), addProtocol(String) and addRealm(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

Credentials

public Credentials(java.lang.String username,
                   java.lang.String password)

Creates new Credentials with the given username and password without any restrictions initially set up.

Parameters:

username - the username to be used

password - the password to be used

Method Detail

getUsername

public java.lang.String getUsername()

Returns the username stored in the Credentials.

Returns:

the username as String

getPassword

public java.lang.String getPassword()

Returns the password stored in the Credentials.

Returns:

the password as String

addRealm

public void addRealm(java.lang.String realm)

Adds a realm as additional security restriction. By setting a realm, this Credentials should only be returned to a server asking for the given HTTP realm.

Parameters:

realm - the new realm to be added to the list of realms

addHostname

public void addHostname(java.lang.String hostname)

Adds a new hostname as additional security restriction. By setting a hostname, this Credentials should only be returned to a server with the given hostname.

If an URL is provided as argument, the hostname will be parsed automatically by removing the protocol as well as path informations. It is therefore save to pass URLs to this method.

To verify mathcing hostnames use matchesURL(String).

Parameters:

hostname - the new hostname to be added to the list of hostnames

addProtocol

public void addProtocol(java.lang.String protocol)

Adds a protocol as additional security restriction. By setting a protocol, this Credentials should only be returned to a server using the given protocol.

Parameters:

protocol - the new protocol to be added to the list of protocols

matchesURL

public boolean matchesURL(java.lang.String url)

Checks if a given URL matches the hostnames and protocols set as restrictions using addHostname(String) and addProtocol(String).

Parameters:

url - the URL to check

Returns:

true if it matches the hostnames and protocols, false if not.

matchesURL

public boolean matchesURL(java.lang.String url,
                          java.lang.String realm)

Checks if the given URL and realm match the hostnames, protocols and realms set as restrictions using addHostname(String), addProtocol(String) and addRealm(String).

Parameters:

url - the URL to check

realm - the realm to check

Returns:

true if it matches hostnames, protocols and realms false if not.

getRealms

public java.util.Vector getRealms()

Returns all realms added as restrictions to this Credentials .

Returns:

all realms added as restrictions or null if no realms are set

getHostnames

public java.util.Vector getHostnames()

Returns all hostnames added as restrictions to this Credentials.

Returns:

all hostnames added as restrictions or null if no hostnames are set

getProtocols

public java.util.Vector getProtocols()

Returns all protocols added as restrictions to this Credentials.

Returns:

all protocols added as restriction or null if no protocols are set