org.smallmind.bayeux.oumuamua.server.api.Server Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oumuamua-server-api Show documentation
Oumuamua Server Api
There is a newer version: 6.2.0
/*
 * Copyright (c) 2007 through 2024 David Berkman
 *
 * This file is part of the SmallMind Code Project.
 *
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 *
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * ...or...
 *
 * 2) The terms of the Apache License, Version 2.0.
 *
 * The SmallMind Code Project is distributed in the hope that it will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License or Apache License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.bayeux.oumuamua.server.api;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import org.smallmind.bayeux.oumuamua.server.api.backbone.Backbone;
import org.smallmind.bayeux.oumuamua.server.api.json.Codec;
import org.smallmind.bayeux.oumuamua.server.api.json.Value;

public interface Server> extends Attributed {

  String ATTRIBUTE = "org.smallmind.bayeux.oumuamua.server";

  interface Listener> {

  }

  interface SessionListener> extends Listener {

    void onConnected (Session session);

    void onDisconnected (Session session);
  }

  interface ChannelListener> extends Listener {

    void onCreated (Channel channel);

    void onRemoved (Channel channel);
  }

  interface SubscriptionListener> extends Listener {

    void onSubscribed (Channel channel, Session session);

    void onUnsubscribed (Channel channel, Session session);
  }

  interface PacketListener> extends Listener {

    Packet onRequest (Session sender, Packet packet);

    Packet onResponse (Session sender, Packet packet);

    Packet onDelivery (Session sender, Packet packet);
  }

  void addListener (Listener listener);

  void removeListener (Listener listener);

  void start (ServletConfig servletConfig)
    throws ServletException;

  void stop ();

  String getBayeuxVersion ();

  String getMinimumBayeuxVersion ();

  long getSessionConnectionIntervalMilliseconds ();

  String[] getProtocolNames ();

  Protocol getProtocol (String name);

  Backbone getBackbone ();

  SecurityPolicy getSecurityPolicy ();

  // Serves as an injection point for implementations that wish to add client configurable additions to the json codec pipeline
  Codec getCodec ();

  boolean isReflective (Route route);

  boolean isStreaming (Route route);

  Session getSession (String sessionId);

  void addInitializer (ChannelInitializer initializer);

  void removeInitializer (ChannelInitializer initializer);

  Channel findChannel (String path)
    throws InvalidPathException;

  // Initializers will be applied before the channel is returned if this call creates the channel
  Channel requireChannel (String path, ChannelInitializer... initializers)
    throws InvalidPathException;

  // It's n error to attempt to remove a persistent channel
  // All sessions must be unsubscribed (and listeners notified) upon channel removal
  void removeChannel (Channel channel)
    throws ChannelStateException;

  Packet onRequest (Session sender, Packet packet);

  Packet onResponse (Session sender, Packet packet);

  void deliver (Session sender, Packet packet, boolean clustered);

  void forward (Channel channel, Packet packet);
}