Package org.eclipse.jetty.websocket.common.extensions

Class WebSocketExtensionFactory

java.lang.Object

org.eclipse.jetty.websocket.api.extensions.ExtensionFactory

org.eclipse.jetty.websocket.common.extensions.WebSocketExtensionFactory

All Implemented Interfaces:

java.lang.Iterable<java.lang.Class<? extends Extension>>, Dumpable, LifeCycle

public class WebSocketExtensionFactory
extends ExtensionFactory
implements LifeCycle, Dumpable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
WebSocketExtensionFactory(WebSocketContainerScope container)

Method Summary

Modifier and Type	Method	Description
void	addLifeCycleListener(LifeCycle.Listener listener)
java.lang.String	dump()
void	dump(java.lang.Appendable out, java.lang.String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
java.lang.String	dumpSelf()	The description of this/self found in the dump.
java.util.Map<java.lang.String,java.lang.Class<? extends Extension>>	getAvailableExtensions()
java.lang.Class<? extends Extension>	getExtension(java.lang.String name)
java.util.Set<java.lang.String>	getExtensionNames()
boolean	isAvailable(java.lang.String name)
boolean	isFailed()
boolean	isRunning()
boolean	isStarted()
boolean	isStarting()
boolean	isStopped()
boolean	isStopping()
java.util.Iterator<java.lang.Class<? extends Extension>>	iterator()
Extension	newInstance(ExtensionConfig config)
void	register(java.lang.String name, java.lang.Class<? extends Extension> extension)
void	removeLifeCycleListener(LifeCycle.Listener listener)
void	start()	Starts the component.
void	stop()	Stops the component.
java.lang.String	toString()
void	unregister(java.lang.String name)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WebSocketExtensionFactory

public WebSocketExtensionFactory(WebSocketContainerScope container)

Method Detail

getAvailableExtensions

public java.util.Map<java.lang.String,java.lang.Class<? extends Extension>> getAvailableExtensions()

Overrides:

getAvailableExtensions in class ExtensionFactory

getExtension

public java.lang.Class<? extends Extension> getExtension(java.lang.String name)

Overrides:

getExtension in class ExtensionFactory

getExtensionNames

public java.util.Set<java.lang.String> getExtensionNames()

Overrides:

getExtensionNames in class ExtensionFactory

isAvailable

public boolean isAvailable(java.lang.String name)

Overrides:

isAvailable in class ExtensionFactory

newInstance

public Extension newInstance(ExtensionConfig config)

Specified by:

newInstance in class ExtensionFactory

register

public void register(java.lang.String name,
                     java.lang.Class<? extends Extension> extension)

Overrides:

register in class ExtensionFactory

unregister

public void unregister(java.lang.String name)

Overrides:

unregister in class ExtensionFactory

iterator

public java.util.Iterator<java.lang.Class<? extends Extension>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Class<? extends Extension>>

Overrides:

iterator in class ExtensionFactory

start

public void start()
           throws java.lang.Exception

Description copied from interface: LifeCycle

Starts the component.

Specified by:

start in interface LifeCycle

Throws:

java.lang.Exception - If the component fails to start

See Also:

LifeCycle.isStarted(), LifeCycle.stop(), LifeCycle.isFailed()

stop

public void stop()
          throws java.lang.Exception

Description copied from interface: LifeCycle

Stops the component. The component may wait for current activities to complete normally, but it can be interrupted.

Specified by:

stop in interface LifeCycle

Throws:

java.lang.Exception - If the component fails to stop

See Also:

LifeCycle.isStopped(), LifeCycle.start(), LifeCycle.isFailed()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle

Returns:

true if the component is starting or has been started.

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

Returns:

true if the component has been started.

See Also:

LifeCycle.start(), LifeCycle.isStarting()

isStarting

public boolean isStarting()

Specified by:

isStarting in interface LifeCycle

Returns:

true if the component is starting.

See Also:

LifeCycle.isStarted()

isStopping

public boolean isStopping()

Specified by:

isStopping in interface LifeCycle

Returns:

true if the component is stopping.

See Also:

LifeCycle.isStopped()

isStopped

public boolean isStopped()

Specified by:

isStopped in interface LifeCycle

Returns:

true if the component has been stopped.

See Also:

LifeCycle.stop(), LifeCycle.isStopping()

isFailed

public boolean isFailed()

Specified by:

isFailed in interface LifeCycle

Returns:

true if the component has failed to start or has failed to stop.

addLifeCycleListener

public void addLifeCycleListener(LifeCycle.Listener listener)

Specified by:

addLifeCycleListener in interface LifeCycle

removeLifeCycleListener

public void removeLifeCycleListener(LifeCycle.Listener listener)

Specified by:

removeLifeCycleListener in interface LifeCycle

dump

public java.lang.String dump()

Specified by:

dump in interface Dumpable

dumpSelf

public java.lang.String dumpSelf()

Description copied from interface: Dumpable

The description of this/self found in the dump. Allows for alternative representation of Object other then .toString() where the long form output of toString() is represented in a cleaner way within the dump infrastructure.

Specified by:

dumpSelf in interface Dumpable

Returns:

the representation of self

dump

public void dump(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

java.io.IOException - if unable to write to Appendable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object