|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.publishing.AbstractChannelType
public abstract class AbstractChannelType
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.alfresco.service.cmr.publishing.channels.ChannelType |
---|
ChannelType.AuthStatus |
Constructor Summary | |
---|---|
AbstractChannelType()
|
Method Summary | |
---|---|
ChannelType.AuthStatus |
acceptAuthorisationCallback(Channel channel,
java.util.Map callbackHeaders,
java.util.Map callbackParams)
This operation is called after the service provider represented by this channel type has redirected the user back to Alfresco. |
java.lang.String |
getAuthorisationUrl(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. |
protected ChannelService |
getChannelService()
|
protected MetadataEncryptor |
getEncryptor()
|
org.springframework.core.io.Resource |
getIcon(java.lang.String sizeSuffix)
Obtain the resource that represents an icon for this channel type. |
java.lang.String |
getIconFileExtension()
|
int |
getMaximumStatusLength()
If this channel type supports status updates then this operation returns the maximum permitted length of those status updates. |
protected org.alfresco.service.cmr.repository.NodeService |
getNodeService()
|
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. |
protected ChannelType.AuthStatus |
internalAcceptAuthorisation(Channel channel,
java.util.Map callbackHeaders,
java.util.Map callbackParams)
|
void |
publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish,
java.util.Map channelProperties)
|
void |
sendStatusUpdate(Channel channel,
java.lang.String status)
Send the specified status update to the specified channel |
void |
setChannelService(ChannelService channelService)
|
void |
setEncryptor(MetadataEncryptor encryptor)
|
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
|
void |
unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish,
java.util.Map channelProperties)
|
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 |
---|
public AbstractChannelType()
Method Detail |
---|
public void setChannelService(ChannelService channelService)
protected ChannelService getChannelService()
public void setEncryptor(MetadataEncryptor encryptor)
protected MetadataEncryptor getEncryptor()
protected org.alfresco.service.cmr.repository.NodeService getNodeService()
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
public int getMaximumStatusLength()
getMaximumStatusLength
in interface ChannelType
public java.lang.String getAuthorisationUrl(Channel channel, java.lang.String callbackUrl)
ChannelType
getAuthorisationUrl
in interface ChannelType
channel
- The channel that needs to be authorised.callbackUrl
- Where the service provider represented by this channel type should redirect the user to once
the authorisation procedure is complete.
public final ChannelType.AuthStatus acceptAuthorisationCallback(Channel channel, java.util.Map callbackHeaders, java.util.Map callbackParams)
ChannelType
acceptAuthorisationCallback
in interface ChannelType
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.
protected ChannelType.AuthStatus internalAcceptAuthorisation(Channel channel, java.util.Map callbackHeaders, java.util.Map callbackParams)
public org.springframework.core.io.Resource getIcon(java.lang.String sizeSuffix)
ChannelType
getIcon
in interface ChannelType
sizeSuffix
- A text representation of the icon size required. "16", "32", etc.
null
otherwise.public java.lang.String getIconFileExtension()
public java.util.Set getSupportedContentTypes()
ChannelType
getSupportedContentTypes
in interface ChannelType
public java.util.Set getSupportedMimeTypes()
ChannelType
getSupportedMimeTypes
in interface ChannelType
public void sendStatusUpdate(Channel channel, java.lang.String status)
ChannelType
sendStatusUpdate
in interface ChannelType
public void publish(org.alfresco.service.cmr.repository.NodeRef nodeToPublish, java.util.Map channelProperties)
publish
in interface ChannelTypePublishingOperations
public void unpublish(org.alfresco.service.cmr.repository.NodeRef nodeToUnpublish, java.util.Map channelProperties)
unpublish
in interface ChannelTypePublishingOperations
public java.lang.String getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node)
ChannelType
node
.
getNodeUrl
in interface ChannelType
node
- The published content node in the live environment.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |