swim.api.plane.PlaneContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swim-api Show documentation

Agent programming interface

There is a newer version: 4.3.15

// Copyright 2015-2021 Swim Inc.
//
// 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 swim.api.plane;

import swim.api.agent.Agent;
import swim.api.agent.AgentFactory;
import swim.api.agent.AgentRoute;
import swim.api.auth.Authenticator;
import swim.api.policy.PlanePolicy;
import swim.api.ref.WarpRef;
import swim.concurrent.Schedule;
import swim.concurrent.Stage;
import swim.uri.Uri;
import swim.uri.UriPattern;
import swim.util.Log;

public interface PlaneContext extends WarpRef, Log {

  Schedule schedule();

  Stage stage();

  PlanePolicy policy();

  void setPolicy(PlanePolicy policy);

  Authenticator getAuthenticator(String authenticatorName);

  void addAuthenticator(String authenticatorName, Authenticator authenticator);

   AgentRoute createAgentRoute(Class agentClass);

   AgentRoute getAgentRoute(String routeName);

  void addAgentRoute(String routeName, UriPattern pattern, AgentRoute agentRoute);

  void addAgentRoute(String routeName, String pattern, AgentRoute agentRoute);

  void removeAgentRoute(String routeName);

  AgentFactory getAgentFactory(Uri nodeUri);

}