uPortal 2.4.1
API Documentation

org.jasig.portal.tools.chanpub
Class ChannelPublisher

java.lang.Object
  extended byorg.jasig.portal.tools.chanpub.ChannelPublisher

public class ChannelPublisher
extends java.lang.Object

This is a Channel Publisher tool to install uPortal channels from outside of the portal or from within a channel archive. Currently configured to be executed via Jakarta Ant or via a channel-definition block within a CAR deployment descriptor. Sample of command line arguments: ant publish -Dchannel=all (this will publish all channels that have a corresponding xml file) ant publish -Dchannel=webmail.xml (this will publish the specified channels)

Version:
$Revision: 1.16 $
Author:
Freddy Lopez, flopez@unicon.net, Ken Weiner, kweiner@unicon.net, Mark Boyd, mboyd@sct.com

Method Summary
static ChannelPublisher getChannelArchiveInstance()
           
static ChannelPublisher getCommandLineInstance()
           
static void main(java.lang.String[] args)
           
 ChannelDefinition publishChannel(java.io.InputStream is)
          Publishes the channel represented by the XML accessed via the passed in InputStream object and returns the resultant ChannelDefinition object.
 ChannelDefinition publishChannel(java.lang.String filename)
          Publishes the channel represented by the XML located in the file represented by the passed in filename and returns the resultant ChannelDefinition object.
 void setOverride(boolean b)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

main

public static void main(java.lang.String[] args)

publishChannel

public ChannelDefinition publishChannel(java.lang.String filename)
                                 throws java.lang.Exception
Publishes the channel represented by the XML located in the file represented by the passed in filename and returns the resultant ChannelDefinition object.

Parameters:
filename - the name of a file containing the channel XML definition
Returns:
org.jasig.portal.ChannelDefinition the published channel definition
Throws:
java.lang.Exception

publishChannel

public ChannelDefinition publishChannel(java.io.InputStream is)
                                 throws java.lang.Exception
Publishes the channel represented by the XML accessed via the passed in InputStream object and returns the resultant ChannelDefinition object.

Parameters:
is - and InputStream containing the channel XML definition
Returns:
org.jasig.portal.ChannelDefinition the published channel definition
Throws:
java.lang.Exception

setOverride

public void setOverride(boolean b)

getCommandLineInstance

public static ChannelPublisher getCommandLineInstance()
                                               throws java.lang.Exception
Throws:
java.lang.Exception

getChannelArchiveInstance

public static ChannelPublisher getChannelArchiveInstance()
                                                  throws java.lang.Exception
Throws:
java.lang.Exception

uPortal 2.4.1
API Documentation