public interface ChannelType
Modifier and Type | Interface and Description |
---|---|
static class |
ChannelType.AuthStatus |
static class |
ChannelType.AuthUrlPair |
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.
|
boolean |
isHidden()
If a channel type is hidden then it doesn't appear in the list returned by
ChannelService.getChannelTypes() |
void |
sendStatusUpdate(Channel channel,
String status)
Send the specified status update to the specified channel
|
void |
setHidden(boolean hidden)
If a channel type is hidden then it doesn't appear in the list returned by
ChannelService.getChannelTypes() |
String getId()
String getTitle()
org.alfresco.service.namespace.QName getChannelNodeType()
boolean canPublish()
boolean canUnpublish()
boolean canPublishStatusUpdates()
void sendStatusUpdate(Channel channel, String status)
channel
- Channelstatus
- StringSet<String> getSupportedMimeTypes()
Set<org.alfresco.service.namespace.QName> getSupportedContentTypes()
String getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node)
node
.node
- The published content node in the live environment.int getMaximumStatusLength()
ChannelType.AuthUrlPair getAuthorisationUrls(Channel channel, String alfrescoCallbackUrl)
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.ChannelType.AuthStatus acceptAuthorisationCallback(Channel channel, Map<String,String[]> callbackHeaders, Map<String,String[]> callbackParams)
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.org.springframework.core.io.Resource getIcon(String size)
size
- A text representation of the icon size required. "16", "32", etc.null
otherwise.void setHidden(boolean hidden)
ChannelService.getChannelTypes()
hidden
- boolean isHidden()
ChannelService.getChannelTypes()
hidden
- Copyright © 2005–2017 Alfresco Software. All rights reserved.