org.alfresco.repo.publishing

Class MockChannelType

java.lang.Object

org.alfresco.repo.publishing.AbstractChannelType

org.alfresco.repo.publishing.MockChannelType

All Implemented Interfaces:

ChannelTypePublishingOperations, ChannelType

public class MockChannelType
extends AbstractChannelType

For test purposes only.

Since:

4.0

Author:

Nick Smith

Nested Class Summary

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

ChannelType.AuthStatus, ChannelType.AuthUrlPair

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
MockChannelType()

Method Summary

Modifier and Type	Method and Description
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 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.
Map<String,String>	getCapabilities()
org.alfresco.service.namespace.QName	getChannelNodeType() Each channel is stored in the repository as a node.
org.alfresco.service.namespace.QName	getContentRootNodeType()
String	getId() Returns the unique identifier of this channel type
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.
void	publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish, Map<org.alfresco.service.namespace.QName,Serializable> properties)
void	sendStatusUpdate(Channel channel, String status) Send the specified status update to the specified channel
void	unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish, Map<org.alfresco.service.namespace.QName,Serializable> properties)

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

acceptAuthorisationCallback, getChannelService, getEncryptor, getIcon, getIconFileExtension, getMaximumStatusLength, getNodeService, getTitle, internalAcceptAuthorisation, isHidden, setChannelService, setEncryptor, setHidden, setNodeService

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

MockChannelType

public MockChannelType()

Method Detail

getId

public String getId()

Returns the unique identifier of this channel type

Returns:

String

getCapabilities

public Map<String,String> getCapabilities()

getChannelNodeType

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

Description copied from interface: ChannelType

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

Returns:

QName

getContentRootNodeType

public org.alfresco.service.namespace.QName getContentRootNodeType()

publish

public void publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish,
                    Map<org.alfresco.service.namespace.QName,Serializable> properties)

Specified by:

publish in interface ChannelTypePublishingOperations

Overrides:

publish in class AbstractChannelType

unpublish

public void unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish,
                      Map<org.alfresco.service.namespace.QName,Serializable> properties)

Specified by:

unpublish in interface ChannelTypePublishingOperations

Overrides:

unpublish in class AbstractChannelType

sendStatusUpdate

public void sendStatusUpdate(Channel channel,
                             String status)

Send the specified status update to the specified channel

Specified by:

sendStatusUpdate in interface ChannelType

Overrides:

sendStatusUpdate in class AbstractChannelType

Parameters:

channel - Channel

status - String

canPublish

public boolean canPublish()

Does this channel type support publishing content?

Returns:

boolean

canUnpublish

public 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:

boolean

getSupportedMimeTypes

public Set<String> getSupportedMimeTypes()

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

Specified by:

getSupportedMimeTypes in interface ChannelType

Overrides:

getSupportedMimeTypes in class AbstractChannelType

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

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

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

Specified by:

getSupportedContentTypes in interface ChannelType

Overrides:

getSupportedContentTypes in class AbstractChannelType

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.

canPublishStatusUpdates

public boolean canPublishStatusUpdates()

Does this channel type support status updates?

Returns:

boolean

getNodeUrl

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

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

Specified by:

getNodeUrl in interface ChannelType

Overrides:

getNodeUrl in class AbstractChannelType

Parameters:

node - The published content node in the live environment.

Returns:

a URL for the published content.

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.