dojox.cometd.Bayeux Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// ========================================================================
// Copyright 2007 Dojo Foundation
// ------------------------------------------------------------------------
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//========================================================================
package dojox.cometd;
import java.util.Collection;
/* ------------------------------------------------------------ */
/** Bayeux Interface.
* This interface represents the server side API for the Bayeux messaging protocol.
*
* The implementation of Bayeux will be registered as a {@link javax.servlet.ServletContext} attribute
* with the name "dojox.cometd.bayeux". This may be set prior to the context being initialized
* (if the instance is shared between contexts) or during context initialization.
*
* Bayeux implementations must be thread safe and multiple threads may simultaneously
* call Bayeux methods.
*
*/
public interface Bayeux
{
/**Meta definitions for channels*/
public static final String META="/meta";
/**Meta definitions for channels*/
public static final String META_SLASH="/meta/";
/**Meta definitions for channels - connect message*/
public static final String META_CONNECT="/meta/connect";
/**Meta definitions for channels - client messsage*/
public static final String META_CLIENT="/meta/client";
/**Meta definitions for channels - disconnect messsage*/
public static final String META_DISCONNECT="/meta/disconnect";
/**Meta definitions for channels - handshake messsage*/
public static final String META_HANDSHAKE="/meta/handshake";
/**Meta definitions for channels - ping messsage*/
public static final String META_PING="/meta/ping";
/**Meta definitions for channels - status messsage*/
public static final String META_STATUS="/meta/status";
/**Meta definitions for channels - subscribe messsage*/
public static final String META_SUBSCRIBE="/meta/subscribe";
/**Meta definitions for channels - unsubscribe messsage*/
public static final String META_UNSUBSCRIBE="/meta/unsubscribe";
/*Field names inside Bayeux messages*/
/**Field names inside Bayeux messages - clientId field*/
public static final String CLIENT_FIELD="clientId";
/**Field names inside Bayeux messages - data field*/
public static final String DATA_FIELD="data";
/**Field names inside Bayeux messages - channel field*/
public static final String CHANNEL_FIELD="channel";
/**Field names inside Bayeux messages - id field*/
public static final String ID_FIELD="id";
/**Field names inside Bayeux messages - error field*/
public static final String ERROR_FIELD="error";
/**Field names inside Bayeux messages - timestamp field*/
public static final String TIMESTAMP_FIELD="timestamp";
/**Field names inside Bayeux messages - transport field*/
public static final String TRANSPORT_FIELD="transport";
/**Field names inside Bayeux messages - advice field*/
public static final String ADVICE_FIELD="advice";
/**Field names inside Bayeux messages - successful field*/
public static final String SUCCESSFUL_FIELD="successful";
/**Field names inside Bayeux messages - subscription field*/
public static final String SUBSCRIPTION_FIELD="subscription";
/**Field names inside Bayeux messages - ext field*/
public static final String EXT_FIELD="ext";
/**Field names inside Bayeux messages - connectionType field*/
public static final String CONNECTION_TYPE_FIELD="connectionType";
/**Field names inside Bayeux messages - version field*/
public static final String VERSION_FIELD="version";
/**Field names inside Bayeux messages - minimumVersion field*/
public static final String MIN_VERSION_FIELD="minimumVersion";
/**Field names inside Bayeux messages - supportedConnectionTypes field*/
public static final String SUPP_CONNECTION_TYPE_FIELD="supportedConnectionTypes";
/**Field names inside Bayeux messages - json-comment-filtered field*/
public static final String JSON_COMMENT_FILTERED_FIELD="json-comment-filtered";
/**Field names inside Bayeux messages - reconnect field*/
public static final String RECONNECT_FIELD = "reconnect";
/**Field names inside Bayeux messages - interval field*/
public static final String INTERVAL_FIELD = "interval";
/**Field values inside Bayeux messages - retry response*/
public static final String RETRY_RESPONSE = "retry";
/**Field values inside Bayeux messages - handshake response*/
public static final String HANDSHAKE_RESPONSE = "handshake";
/**Field values inside Bayeux messages - none response*/
public static final String NONE_RESPONSE = "none";
/**Service channel names-starts with*/
public static final String SERVICE="/service";
/**Service channel names-trailing slash*/
public static final String SERVICE_SLASH="/service/";
/*Transport types*/
/**Transport types - long polling*/
public static final String TRANSPORT_LONG_POLL="long-polling";
/**Transport types - callback polling*/
public static final String TRANSPORT_CALLBACK_POLL="callback-polling";
/**Transport types - iframe*/
public static final String TRANSPORT_IFRAME="iframe";
/**Transport types - flash*/
public static final String TRANSPORT_FLASH="flash";
/** ServletContext attribute name used to obtain the Bayeux object */
public static final String DOJOX_COMETD_BAYEUX="dojox.cometd.bayeux";
/*http field names*/
/**http helpers - text/json content type*/
public static final String JSON_CONTENT_TYPE="text/json";
/**http helpers - parameter name for json message*/
public static final String MESSAGE_PARAMETER="message";
/**http helpers - name of the jsonp parameter*/
public static final String JSONP_PARAMETER="jsonp";
/**http helpers - default name of the jsonp callback function*/
public static final String JSONP_DEFAULT_NAME="jsonpcallback";
/* ------------------------------------------------------------ */
/**
* @deprecated user {@link Channel#addDataFilter(DataFilter)}
*/
public void addFilter(String channels, DataFilter filter);
/* ------------------------------------------------------------ */
/** Deliver a message to a client.
* @deprecated use {@link Client#deliver(Client, Message)}
*/
public void deliver(Client fromClient, Client toClient, String toChannel, Message message);
/* ------------------------------------------------------------ */
/** Get a Channel instance by ID.
* @param channelId The Channel ID
* @param create If true, a channel will be created if it does not exist.
* @return A Channel instance or null if it does not exist and create is false.
*/
public Channel getChannel(String channelId,boolean create);
/* ------------------------------------------------------------ */
/** Get all known channels.
* @return A collection of all known channel instances.
*/
public Collection getChannels();
/* ------------------------------------------------------------ */
public Client getClient(String clientId);
/* ------------------------------------------------------------ */
public Collection getClients();
/* ------------------------------------------------------------ */
public SecurityPolicy getSecurityPolicy();
/* ------------------------------------------------------------ */
public boolean hasChannel(String channel);
/* ------------------------------------------------------------ */
public boolean hasClient(String clientId);
/* ------------------------------------------------------------ */
/**
* @deprecated use {@link #newClient(String)}
*/
public Client newClient(String idprefix, Listener listener);
/* ------------------------------------------------------------ */
public Client newClient(String idprefix);
/* ------------------------------------------------------------ */
/** Deliver data to a channel.
* @deprecated use {@link Channel#publish(Client, Object, String)}
* @param fromClient The client sending the data
* @param data The data itself which must be an Object that can be encoded with {@link JSON}.
* @param toChannel The Channel ID to which the data is targetted
* @param msgId optional message ID or null for automatic generation of a message ID.
*/
public void publish(Client fromClient, String toChannel, Object data, String msgId);
/* ------------------------------------------------------------ */
public Channel removeChannel(String channel);
/* ------------------------------------------------------------ */
public Client removeClient(String clientId);
/* ------------------------------------------------------------ */
/**
* @deprecated user {@link Channel#removeDataFilter(DataFilter)}
*/
public void removeFilter(String channels, DataFilter filter);
/* ------------------------------------------------------------ */
/** Set the security policy for the Bayeux instance.
*
* The Security Policy will be called to check access for all handshakes,
* subscriptions and publishing.
*
* @param securityPolicy The security policy instance.
*/
public void setSecurityPolicy(SecurityPolicy securityPolicy);
/* ------------------------------------------------------------ */
/** Subscribe to a channel.
* Equivalent to getChannel(toChannel).subscribe(subscriber).
* @deprecated use {@link Channel#subscribe(Client)}
* @param toChannel
* @param subscriber
* @param createChannel. Create the channel if it does not exist
*/
public void subscribe(String toChannel, Client subscriber);
/* ------------------------------------------------------------ */
/** Unsubscribe to a channel
* @deprecated use {@link Channel#unsubscribe(Client)}
* @param toChannel
* @param subscriber
*/
public void unsubscribe(String toChannel, Client subscriber);
}