org.alfresco.service.cmr.publishing.channels

Interface ChannelType

All Known Implementing Classes:

AbstractChannelType, AbstractOAuth1ChannelType, FacebookChannelType, FlickrChannelType, LinkedInChannelType, MockChannelType, SlideShareChannelType, TwitterChannelType, YouTubeChannelType

public interface ChannelType

Since:

4.0

Author:

Brian

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ChannelType.AuthStatus
static class	ChannelType.AuthUrlPair

Method Summary

Methods

Modifier and Type	Method and Description
ChannelType.AuthStatus	acceptAuthorisationCallback(Channel channel, Map<String,String[]> callbackHeaders, Map<String,String[]> callbackParams) This operation is called after the service provider represented by this channel type has redirected the user back to Alfresco.
boolean	canPublish() Does this channel type support publishing content?
boolean	canPublishStatusUpdates() Does this channel type support status updates?
boolean	canUnpublish() Does this channel type support unpublishing content? That is to say, once content has been published to a channel of this type, can it later be removed from that channel?
ChannelType.AuthUrlPair	getAuthorisationUrls(Channel channel, String alfrescoCallbackUrl) 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.
org.alfresco.service.namespace.QName	getChannelNodeType() Each channel is stored in the repository as a node.
org.springframework.core.io.Resource	getIcon(String size) Obtain the resource that represents an icon for this channel type.
String	getId() Returns the unique identifier of this channel type
int	getMaximumStatusLength() If this channel type supports status updates then this operation returns the maximum permitted length of those status updates.
String	getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node) Returns the URL for a piece of content represented by the supplied node.
Set<org.alfresco.service.namespace.QName>	getSupportedContentTypes() Returns the set of content types supported by channels of this type.
Set<String>	getSupportedMimeTypes() Returns the set of MIME types supported by channels of this type.
String	getTitle() Returns the title (display name) of this channel type.
void	sendStatusUpdate(Channel channel, String status) Send the specified status update to the specified channel

Method Detail

getId

String getId()

Returns the unique identifier of this channel type

Returns:

getTitle

String getTitle()

Returns the title (display name) of this channel type. The title may be localised, but this is implementation specific

Returns:

getChannelNodeType

org.alfresco.service.namespace.QName getChannelNodeType()

Each channel is stored in the repository as a node. This operation returns the qualified name of the type of that node.

Returns:

canPublish

boolean canPublish()

Does this channel type support publishing content?

Returns:

canUnpublish

boolean canUnpublish()

Does this channel type support unpublishing content? That is to say, once content has been published to a channel of this type, can it later be removed from that channel?

Returns:

canPublishStatusUpdates

boolean canPublishStatusUpdates()

Does this channel type support status updates?

Returns:

sendStatusUpdate

void sendStatusUpdate(Channel channel,
                    String status)

Send the specified status update to the specified channel

Parameters:

channel -

status -

getSupportedMimeTypes

Set<String> getSupportedMimeTypes()

Returns the set of MIME types supported by channels of this type.

Returns:

The set of MIME types supported by channels of this type or an empty set if content of any MIME type can be published.

getSupportedContentTypes

Set<org.alfresco.service.namespace.QName> getSupportedContentTypes()

Returns the set of content types supported by channels of this type.

Returns:

The set of content types supported by channels of this type or an empty set if content of any content type can be published.

getNodeUrl

String getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node)

Returns the URL for a piece of content represented by the supplied node.

Parameters:

node - The published content node in the live environment.

Returns:

a URL for the published content.

getMaximumStatusLength

int getMaximumStatusLength()

If this channel type supports status updates then this operation returns the maximum permitted length of those status updates.

Returns:

The maximum length of status updates on channels of this type. A value of zero indicates that there is no maximum.

getAuthorisationUrls

ChannelType.AuthUrlPair getAuthorisationUrls(Channel channel,
                                           String alfrescoCallbackUrl)

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.

Parameters:

channel - The channel that needs to be authorised.

alfrescoCallbackUrl - 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.

acceptAuthorisationCallback

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

This operation is called after the service provider represented by this channel type has redirected the user back to Alfresco. The HTTP headers and parameters received from the service provider are included, as they are likely to contain essential information such as tokens, error codes, and so on.

Parameters:

channel - The channel related to this authorisation callback.

callbackHeaders - All the HTTP headers received in the callback.

callbackParams - All the HTTP parameters received in the callback.

Returns:

A value indicating whether the authorisation was successful or not. If not, there is an indication as to whether the user may try again or not.

getIcon

org.springframework.core.io.Resource getIcon(String size)

Obtain the resource that represents an icon for this channel type.

Parameters:

size - A text representation of the icon size required. "16", "32", etc.

Returns:

The resource that represents the requested icon if available. null otherwise.