info.aduna.gee.spectacle.webserver
Class ChannelManager

java.lang.Object
  info.aduna.gee.spectacle.webserver.ChannelManager

All Implemented Interfaces:

EntryConstants, FileNames, ApiConstants, UserTypes

public class ChannelManager
extends Object
implements ApiConstants, EntryConstants, FileNames, UserTypes

Class ChannelManager provides a Java API to create and remove channels from an a12r publication server.

Field Summary

Fields inherited from interface info.aduna.gee.publication.servlets.ApiConstants

CREATE_EMAIL_KEY, CREATE_NAME_KEY, CREATE_PASSWORD_KEY, CREATE_TIMETOLIVE_KEY, MESSAGE_KEY, RESULT_KEY, RETURN_CODE_KEY

Fields inherited from interface info.aduna.gee.publication.content.EntryConstants

ACLS_PREFIX, AFTER_TRANSFER, APPLET_TYPE_VALUE, ASSOCIATES_EDIT_LEVEL, BEFORE_STORAGE, BEFORE_TRANSFER, CODE_KEY, CODEBASE_KEY, CONSTRUCTION_KEY, CONTAINER_TTL_KEY, CONTAINERID_KEY, CONTAINERPROPS_KEY, DBPRIVACY_LEVEL_KEY, DESCRIPTION_KEY, EMBED_TYPE_VALUE, END_TIME_KEY, ENTRY_ID_KEY, ENTRYATTRIBS_KEY, ENTRYPARAMS_KEY, ENTRYPROPS_KEY, EXPIRES_KEY, EXTERNAL_ENTRY_KEY, HEIGHT_KEY, HTML_KEY, HTML_TYPE_VALUE, ID2IDID_KEY, IMAGE_TYPE_VALUE, IMPORT_CLASSNAME, IMPORT_DONT_FORWARD, IMPORT_IMPORTED, IMPORT_LANGUAGE, IMPORT_SERVER_NAME, IMPORT_TYPE_VALUE, INFO_EXTENSION, INHERIT_CONFIGURATION, INLINE_DESCRIPTION_IS_HTML_KEY, INLINE_DESCRIPTION_KEY, INSPIRES_KEY, JIT_DESTINATION, JIT_DESTINATION_INDEX, LINK_IN_FRAME_KEY, LINK_KEY, MANUAL_KEY, MINIMALHEIGHT_KEY, MINIMALWIDTH_KEY, NAVIGATION_KEY, OBJECT_TYPE_VALUE, OCCURRING_CLABELS_KEY, OVERRIDE_SUGGESTION_KEY, PRIVACY_LEVEL_KEY, PROVIDE_KEY, PROVIDE_PL_KEY, QUALIFIED_BASE_KEY, RE_EXPORT_KEY, RE_MANUAL_KEY, REPEAT_ID_KEY, REPEAT_TODAY_KEY, REQUIRES_NEW_PAGE, ROTATABLE_KEY, SHARED_CLABELS_KEY, SHOP_GIF_KEY, SHOP_GIF_LOCATION_KEY, SHOP_ID_KEY, SHOP_ORIGIN_KEY, SHOP_OVER_GIF_KEY, SORT_CLABELS, SORT_DESCRIPTION, SOURCE_KEY, STARTSECTION_KEY, SUBSCRIBED_COLOR_KEY, SUBSCRIBED_GIF_KEY, SUBSCRIBED_GIF_LOCATION_KEY, SUBSCRIBED_OVER_GIF_KEY, SUBSCRIBED_VISIBLE_CLABELS_KEY, SUBSCRIPTION_KEY, SUBSCRIPTION_LINK_KEY, SUGGESTION_KEY, SUMMARY_IS_HTML_KEY, SUMMARY_KEY, SUMMARY_TYPE_VALUE, TEMPLATEPREFERENCES_KEY, TEXT_KEY, TEXT_TYPE_VALUE, TIME_KEY, TMPL_DESCRIPTOR_KEY, TMPL_FOREIGN_ID_KEY, TMPL_ID_KEY, TMPL_PREFERENCES_KEY, TMPL_STUB_RECOGNIZER_KEY, TMPLD_TYPE_VALUE, TYPE_KEY, WIDTH_KEY

Fields inherited from interface info.aduna.gee.publication.net.FileNames

ASA_FILE_NAME, BAK_FILE_NAME, CAT_FILE_NAME, CFG_FILE_NAME, CHS_FILE_NAME, DAT_FILE_NAME, HLP_FILE_NAME, LOCAL_FILE_PREFIX, SBS_FILE_NAME, SSS_FILE_NAME, WIF_FILE_NAME

Fields inherited from interface info.aduna.gee.publication.UserTypes

API_BIT, COVER_BUILDER_BIT, ENGINE_BIT, GUEST_BITS, OWNER_BITS, PRO_BITS, PROUSER_BIT, SERVER_BIT, SHOP_BIT, SHOW_BIT, SHOW_BITS, VISITOR_BIT

Constructor Summary

ChannelManager()

Method Summary

static Channel	create(String server, String name, String password, String email, int timeToLive) Create a new channel and login to it.
static String	getServer(String server)
static String	getServerPath(String server)
static void	remove(Channel channel) Remove the specified channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelManager

public ChannelManager()

Method Detail

create

public static Channel create(String server,
                             String name,
                             String password,
                             String email,
                             int timeToLive)
                      throws ChannelException

Create a new channel and login to it.

Parameters:

server - The name of the server or the complete server path, e.g. "https://www.securehost.com:7565/"

name - The name of the new channel, or null. If unspecified, a new unique name will be generated for the channel.

password - The password to be used to authorize for the channel, or null. If unspecified, a password will be generated.

email - The email address to which the password is sent, or null.

timeToLive - The maximum idle-time in seconds for the new channel after which it is automatically destroyed, or 0.

Throws:

ChannelException - if a problem occurred during creation or while logging in.

See Also:

Channel.login(), Channel.getName(), Channel.getPassword(), remove(Channel)

remove

public static void remove(Channel channel)
                   throws ChannelException

Remove the specified channel. This will completely remove the channel from the server.

Throws:

ChannelException - if a problem occurred while removing the channel

getServerPath

public static String getServerPath(String server)

Parameters:

server - either a server ("myhost") or already a serverPath ("https://www.mysecurehost.com:9898/")

Returns:

a server path

getServer

public static String getServer(String server)

Parameters:

server - either a server ("myhost") or already a serverPath ("https://www.mysecurehost.com:9898/")

Returns:

the server name