org.alfresco.repo.publishing.test

Class TestChannelType1

java.lang.Object

org.alfresco.repo.publishing.AbstractChannelType

org.alfresco.repo.publishing.test.TestChannelType1

All Implemented Interfaces:

ChannelTypePublishingOperations, ChannelType

public class TestChannelType1
extends AbstractChannelType

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
TestChannelType1()

Method Summary

Methods

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, java.lang.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.
org.alfresco.service.namespace.QName	getChannelNodeType() Each channel is stored in the repository as a node.
java.lang.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.
java.lang.String	getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node) Returns the URL for a piece of content represented by the supplied node.
java.util.Set	getSupportedContentTypes() Returns the set of content types supported by channels of this type.
java.util.Set	getSupportedMimeTypes() Returns the set of MIME types supported by channels of this type.
void	publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish, java.util.Map properties)
void	sendStatusUpdate(Channel channel, java.lang.String status) Send the specified status update to the specified channel
void	unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish, java.util.Map properties)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TestChannelType1

public TestChannelType1()

Method Detail

canPublish

public boolean canPublish()

Description copied from interface: ChannelType

Does this channel type support publishing content?

Returns:

canPublishStatusUpdates

public boolean canPublishStatusUpdates()

Description copied from interface: ChannelType

Does this channel type support status updates?

Returns:

canUnpublish

public boolean canUnpublish()

Description copied from interface: ChannelType

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:

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:

getId

public java.lang.String getId()

Description copied from interface: ChannelType

Returns the unique identifier of this channel type

Returns:

getMaximumStatusLength

public int getMaximumStatusLength()

Description copied from class: AbstractChannelType

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

Specified by:

getMaximumStatusLength in interface ChannelType

Overrides:

getMaximumStatusLength in class AbstractChannelType

Returns:

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

getNodeUrl

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

Description copied from interface: ChannelType

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.

getSupportedContentTypes

public java.util.Set getSupportedContentTypes()

Description copied from interface: ChannelType

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.

getSupportedMimeTypes

public java.util.Set getSupportedMimeTypes()

Description copied from interface: ChannelType

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.

publish

public void publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish,
           java.util.Map properties)

Specified by:

publish in interface ChannelTypePublishingOperations

Overrides:

publish in class AbstractChannelType

unpublish

public void unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish,
             java.util.Map properties)

Specified by:

unpublish in interface ChannelTypePublishingOperations

Overrides:

unpublish in class AbstractChannelType

sendStatusUpdate

public void sendStatusUpdate(Channel channel,
                    java.lang.String status)

Description copied from interface: ChannelType

Send the specified status update to the specified channel

Specified by:

sendStatusUpdate in interface ChannelType

Overrides:

sendStatusUpdate in class AbstractChannelType

getAuthorisationUrls

public ChannelType.AuthUrlPair getAuthorisationUrls(Channel channel,
                                           java.lang.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.