org.nuxeo.opensocial.shindig.crypto

Class OpenSocialDescriptor

java.lang.Object

org.nuxeo.opensocial.shindig.crypto.OpenSocialDescriptor

public class OpenSocialDescriptor
extends Object

This class is the java-level description of the parameters that are configured into the opensocial implementation. This contribution is usually packaged as default-opensocial-config.xml and resides in the config directory. The implementation of opensocial is based on shindig 1.1 and is integrated inside nuxeo itself (there is no extra "shindig process").

Author:

iansmith, Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
protected String	callbackUrl This is the URL that shindig should tell other servers to use to call us back on.
static Pattern	DEFAULT_BIND_ADDRESS_PATTERN Deprecated.
static String	LOCALHOST
static String	LOCALHOST_BIND_ADDRESS Deprecated.
static Pattern	LOOPBACK_IP_PATTERN
static String	NUXEO_BIND_ADDRESS_PROPERTY Deprecated.
protected PortalConfig[]	portal You can have any number of portal configurations, but most people should simply ignore this.
protected boolean	propagateJSESSIONIDToTrustedHosts This is a compatibility flag to allow JSESSIONID propagation between Shindig and Nuxeo.
protected OAuthServiceDescriptor[]	services You can have any number of oauthservice configurations, but most people should simply ignore this.
protected String	signingKey This field is the key that is used by shindig to communicate with itself.
static String	TRUSTED_HOSTS_SEPARATOR
protected List<String>	trustedHosts This a list of nuxeo trusted hosts.

Constructor Summary

Constructors

Constructor and Description
OpenSocialDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getCallbackUrl()
OAuthServiceDescriptor[]	getOAuthServices()
PortalConfig[]	getPortalConfig() For now, this is always null because it isn't used.
String	getSigningKey()
protected String	getTrustedHostForNuxeoBindAddress() Deprecated. the loopback URL isn ow used to defined the default trusted host
protected String	getTrustedHostFromLoopbackURL()
String[]	getTrustedHosts()
boolean	isTrustedHost(String host)
boolean	propagateJSESSIONIDToTrustedHosts()
void	setSigningKey(String keyAsBase64)
void	setTrustedHosts(String trustedHosts)

Methods inherited from class java.lang.Object

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

Field Detail

TRUSTED_HOSTS_SEPARATOR

public static final String TRUSTED_HOSTS_SEPARATOR

See Also:

Constant Field Values

LOOPBACK_IP_PATTERN

public static final Pattern LOOPBACK_IP_PATTERN

LOCALHOST

public static final String LOCALHOST

See Also:

Constant Field Values

NUXEO_BIND_ADDRESS_PROPERTY

@Deprecated
public static final String NUXEO_BIND_ADDRESS_PROPERTY

Deprecated.

See Also:

Constant Field Values

LOCALHOST_BIND_ADDRESS

@Deprecated
public static final String LOCALHOST_BIND_ADDRESS

Deprecated.

See Also:

Constant Field Values

DEFAULT_BIND_ADDRESS_PATTERN

@Deprecated
public static final Pattern DEFAULT_BIND_ADDRESS_PATTERN

Deprecated.

signingKey

protected String signingKey

This field is the key that is used by shindig to communicate with itself. For example, sometimes the interpretation of a gadget results in a call to the "make request" servlet for access to external resources. This symmetric key is used to sign the message going from shindig to shindig to verify that the message received by the make request servlet is not "forged".

This value can and, in most cases should, be left empty. When it is left empty, the system will use a random set of bytes for this key.

callbackUrl

protected String callbackUrl

This is the URL that shindig should tell other servers to use to call us back on. If you have changed where nuxeo is mounted (not in /nuxeo) you may need to set this to have your prefix.

If you are running nuxeo in the default configuration, you should not need to configure this.

propagateJSESSIONIDToTrustedHosts

protected boolean propagateJSESSIONIDToTrustedHosts

This is a compatibility flag to allow JSESSIONID propagation between Shindig and Nuxeo. The default value is 'false' and Signed Fetch is used.

portal

protected PortalConfig[] portal

You can have any number of portal configurations, but most people should simply ignore this.

trustedHosts

protected List<String> trustedHosts

This a list of nuxeo trusted hosts. Such a host will be passed the browsers jsession id to avoid the need to constantly re-authenticate to retrieve nuxeo data when the user is already logged into a nuxeo server to access the dashboard. Will be colon separated.

services

protected OAuthServiceDescriptor[] services

You can have any number of oauthservice configurations, but most people should simply ignore this.

Constructor Detail

OpenSocialDescriptor

public OpenSocialDescriptor()

Method Detail

getSigningKey

public String getSigningKey()

getPortalConfig

public PortalConfig[] getPortalConfig()

For now, this is always null because it isn't used.

getCallbackUrl

public String getCallbackUrl()

setSigningKey

public void setSigningKey(String keyAsBase64)

setTrustedHosts

public void setTrustedHosts(String trustedHosts)

getTrustedHostFromLoopbackURL

protected String getTrustedHostFromLoopbackURL()

getTrustedHostForNuxeoBindAddress

@Deprecated
protected String getTrustedHostForNuxeoBindAddress()

Deprecated. the loopback URL isn ow used to defined the default trusted host

Returns the default trusted host computed from the Nuxeo bind address. If Nuxeo listens on all IPs, returns "127.0.0.1", otherwise returns the Nuxeo bind address.

Since:

5.4.2

getTrustedHosts

public String[] getTrustedHosts()

isTrustedHost

public boolean isTrustedHost(String host)

getOAuthServices

public OAuthServiceDescriptor[] getOAuthServices()

propagateJSESSIONIDToTrustedHosts

public boolean propagateJSESSIONIDToTrustedHosts()