org.nuxeo.opensocial.service.api

Interface OpenSocialService

All Known Implementing Classes:

OpenSocialServiceImpl

public interface OpenSocialService

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.shindig.gadgets.GadgetSpecFactory	getGadgetSpecFactory() Returns our own gadget Spec Factory
String	getOAuthCallbackUrl() Where the Oauth "return callback" should go.
OAuthServiceDescriptor[]	getOAuthServices() Get a list of the configured external service providers that we want to communicate with.
PortalConfig[]	getPortalConfig() PortalConfig array that represents the contribution from the user in the opensocial xp.
ProxySelector	getProxySelector() Returns the proxy settings if set
byte[]	getSigningStateKeyBytes() Same as above, but in byte form.
File	getSigningStateKeyFile() Returns a file handle to the base64 encoded key that is used to sign internal requests.
String[]	getTrustedHosts() Return a list of hosts that can be considered as trusted : i.e : we can use internal sign fetch or propagate JSESSIONID
boolean	isTrustedHost(String host) Returns true if the given host is a trusted host, false otherwise.
boolean	propagateJSESSIONIDToTrustedHosts() For communication between Shindig and Nuxeo we have 2 options : - use Signed Fetch based on a dynamically generated shared key - propagate the JSESSIONID Since propagating JSESSIONID is a "hack" and requires specific code in the gadget JS, the default is false.
void	setInjector(com.google.inject.Injector injector) Specify the GUICE injector to user for the service
void	setupOpenSocial() We have had to make this public because it must be called at exactly the right time the initialization sequence.

Method Detail

getGadgetSpecFactory

org.apache.shindig.gadgets.GadgetSpecFactory getGadgetSpecFactory()

Returns our own gadget Spec Factory

setInjector

void setInjector(com.google.inject.Injector injector)

Specify the GUICE injector to user for the service

getProxySelector

ProxySelector getProxySelector()

Returns the proxy settings if set

getSigningStateKeyFile

File getSigningStateKeyFile()

Returns a file handle to the base64 encoded key that is used to sign internal requests.

getSigningStateKeyBytes

byte[] getSigningStateKeyBytes()

Same as above, but in byte form. This is cached.

getOAuthServices

OAuthServiceDescriptor[] getOAuthServices()

Get a list of the configured external service providers that we want to communicate with.

getPortalConfig

PortalConfig[] getPortalConfig()

PortalConfig array that represents the contribution from the user in the opensocial xp. This is normally null.

getOAuthCallbackUrl

String getOAuthCallbackUrl()

Where the Oauth "return callback" should go. This has to be configured to the name (and path) that other servers see the nuxeo instance as.

getTrustedHosts

String[] getTrustedHosts()

Return a list of hosts that can be considered as trusted : i.e : we can use internal sign fetch or propagate JSESSIONID

isTrustedHost

boolean isTrustedHost(String host)

Returns true if the given host is a trusted host, false otherwise.

setupOpenSocial

void setupOpenSocial()
                     throws Exception

We have had to make this public because it must be called at exactly the right time the initialization sequence. This should be called BEFORE guice initialization of shindig happens.

Throws:

Exception

propagateJSESSIONIDToTrustedHosts

boolean propagateJSESSIONIDToTrustedHosts()

For communication between Shindig and Nuxeo we have 2 options : - use Signed Fetch based on a dynamically generated shared key - propagate the JSESSIONID Since propagating JSESSIONID is a "hack" and requires specific code in the gadget JS, the default is false.

Returns: