org.alfresco.repo.publishing

Class AbstractOAuth1ChannelType<A>

java.lang.Object

org.alfresco.repo.publishing.AbstractChannelType

org.alfresco.repo.publishing.AbstractOAuth1ChannelType<A>

Type Parameters:

A - The API type, e.g. Twitter, Flickr, LinkedIn, etc.

All Implemented Interfaces:

ChannelTypePublishingOperations, ChannelType

Direct Known Subclasses:

FlickrChannelType, LinkedInChannelType, TwitterChannelType

public abstract class AbstractOAuth1ChannelType<A>
extends AbstractChannelType

Since:

4.0

Author:

Brian, Nick Smith

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.service.cmr.publishing.channels.ChannelType

ChannelType.AuthStatus, ChannelType.AuthUrlPair

Constructor Summary

Constructors

Constructor and Description
AbstractOAuth1ChannelType()

Method Summary

Modifier and Type	Method and Description
ChannelType.AuthUrlPair	getAuthorisationUrls(Channel channel, String callbackUrl) When creating a new channel of this type, this operation is called to find out where the user should be taken in order to authorise Alfresco to publish content / status updates to that channel.
protected org.springframework.social.connect.Connection<A>	getConnectionForChannel(org.alfresco.service.cmr.repository.NodeRef channelNode)
protected org.springframework.social.oauth1.OAuth1Parameters	getOAuth1Parameters(String callbackUrl) Override this method to add additonal parameters onto the URL that the user is redirected to to authorise access to their account.
protected String	getOAuthVerifierParamName()
protected ChannelType.AuthStatus	internalAcceptAuthorisation(Channel channel, Map<String,String[]> callbackHeaders, Map<String,String[]> callbackParams)
void	setConnectionFactory(org.springframework.social.connect.support.OAuth1ConnectionFactory<A> connectionFactory)

Methods inherited from class org.alfresco.repo.publishing.AbstractChannelType

acceptAuthorisationCallback, getChannelService, getEncryptor, getIcon, getIconFileExtension, getMaximumStatusLength, getNodeService, getNodeUrl, getSupportedContentTypes, getSupportedMimeTypes, getTitle, isHidden, publish, sendStatusUpdate, setChannelService, setEncryptor, setHidden, setNodeService, unpublish

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.service.cmr.publishing.channels.ChannelType

canPublish, canPublishStatusUpdates, canUnpublish, getChannelNodeType, getId

Constructor Detail

AbstractOAuth1ChannelType

public AbstractOAuth1ChannelType()

Method Detail

getConnectionForChannel

protected org.springframework.social.connect.Connection<A> getConnectionForChannel(org.alfresco.service.cmr.repository.NodeRef channelNode)

getAuthorisationUrls

public ChannelType.AuthUrlPair getAuthorisationUrls(Channel channel,
                                                    String callbackUrl)

Description copied from interface: ChannelType

When creating a new channel of this type, this operation is called to find out where the user should be taken in order to authorise Alfresco to publish content / status updates to that channel.

Specified by:

getAuthorisationUrls in interface ChannelType

Overrides:

getAuthorisationUrls in class AbstractChannelType

Parameters:

channel - The channel that needs to be authorised.

callbackUrl - Where the user's browser needs to send the authorisation tokens once the authorisation procedure is complete. If possible, the authorisation URL should include this information so the service provider can send the tokens straight back to us via the browser without any intermediate steps being needed.

Returns:

The URL that the user should be taken to in order to authorise access to Alfresco for the specified channel.

internalAcceptAuthorisation

protected ChannelType.AuthStatus internalAcceptAuthorisation(Channel channel,
                                                             Map<String,String[]> callbackHeaders,
                                                             Map<String,String[]> callbackParams)

Overrides:

internalAcceptAuthorisation in class AbstractChannelType

getOAuth1Parameters

protected org.springframework.social.oauth1.OAuth1Parameters getOAuth1Parameters(String callbackUrl)

Override this method to add additonal parameters onto the URL that the user is redirected to to authorise access to their account. By default, no parameters are added, but this may be useful to specify things such as the permissions being sought, and so on.

Parameters:

callbackUrl - String

Returns:

Do not return null. If no parameters are to be added, return OAuth1Parameters.NONE

getOAuthVerifierParamName

protected String getOAuthVerifierParamName()

setConnectionFactory

public void setConnectionFactory(org.springframework.social.connect.support.OAuth1ConnectionFactory<A> connectionFactory)

Parameters:

connectionFactory - the connectionFactory to set