Channel.java

/*
 * 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;

/* ------------------------------------------------------------ */
/** A Bayeux Channel.
 * 
 */
public interface Channel
{
    /* ------------------------------------------------------------ */
    /**
     * @return true if the Channel has been removed, false if it was not possible to remove the channel
     */
    public abstract boolean remove();

    /* ------------------------------------------------------------ */
    public abstract String getId();

    /* ------------------------------------------------------------ */
    /** Publish a message
     * This is equivalent to Bayeux.publish(fromClient,channel.getId(),data,msgId).
     */
    public void publish(Client fromClient, Object data, String msgId);
    
    /* ------------------------------------------------------------ */
    /** Is the channel persistent.
     * Non persistent channels are removed when the last subscription is
     * removed 
     * @return true if the Channel will persist without any subscription.
     */
    public boolean isPersistent();
    
    /* ------------------------------------------------------------ */
    /**
     * @param persistent true if the Channel will persist without any subscription.
     */
    public void setPersistent(boolean persistent);
    
    /* ------------------------------------------------------------ */
    /** Subscribe to a channel.
     * Equivalent to bayeux.subscribe(channel.getId(),subscriber,false);
     * @param toChannel
     * @param subscriber
     */
    public void subscribe(Client subscriber);

    /* ------------------------------------------------------------ */
    /** Unsubscribe to a channel
     * @param toChannel
     * @param subscriber
     */
    public void unsubscribe(Client subscriber);

    /* ------------------------------------------------------------ */
    public Collection<Client> getSubscribers();

    /* ------------------------------------------------------------ */
    public int getSubscriberCount();
 
    /* ------------------------------------------------------------ */
    public void addDataFilter(DataFilter filter);

    /* ------------------------------------------------------------ */
    public DataFilter removeDataFilter(DataFilter filter);

    /* ------------------------------------------------------------ */
    public Collection<DataFilter> getDataFilters();

}