com.hotels.styx.proxy.plugin

Class NamedPlugin

java.lang.Object

com.hotels.styx.proxy.plugin.NamedPlugin

All Implemented Interfaces:

HttpInterceptor, Plugin, StyxLifecycleListener

public final class NamedPlugin
extends Object
implements Plugin

Represents a plugin that has been loaded into styx under its configured name.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hotels.styx.api.HttpInterceptor

HttpInterceptor.Chain, HttpInterceptor.Context

Field Summary

Fields inherited from interface com.hotels.styx.api.plugins.spi.Plugin

PASS_THROUGH

Method Summary

Modifier and Type	Method and Description
Map<String,HttpHandler>	adminInterfaceHandlers()
boolean	enabled() Returns true if the plugin is enabled, false if disabled.
Eventual<LiveHttpResponse>	intercept(LiveHttpRequest request, HttpInterceptor.Chain chain)
String	name()
static NamedPlugin	namedPlugin(String name, Plugin plugin)
Plugin	originalPlugin()
void	setEnabled(boolean enabled) Enables or disables the plugin.
void	styxStarting()
void	styxStopping()

Methods inherited from class java.lang.Object

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

Method Detail

namedPlugin

public static NamedPlugin namedPlugin(String name,
                                      Plugin plugin)

originalPlugin

public Plugin originalPlugin()

name

public String name()

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the plugin.

Parameters:

enabled - true to enable, false to disable

enabled

public boolean enabled()

Returns true if the plugin is enabled, false if disabled.

Returns:

true if the plugin is enabled, false if disabled

styxStarting

public void styxStarting()

Specified by:

styxStarting in interface StyxLifecycleListener

styxStopping

public void styxStopping()

Specified by:

styxStopping in interface StyxLifecycleListener

adminInterfaceHandlers

public Map<String,HttpHandler> adminInterfaceHandlers()

Specified by:

adminInterfaceHandlers in interface Plugin

intercept

public Eventual<LiveHttpResponse> intercept(LiveHttpRequest request,
                                            HttpInterceptor.Chain chain)

Specified by:

intercept in interface HttpInterceptor