Grizzly NIO 5.0.2 · org.glassfish.grizzly.http.ajp.AjpHandlerFilter

Modifier and Type	Field and Description
private final Attribute<AjpHttpRequest>	httpRequestInProcessAttr
private boolean	isTomcatAuthentication
private static final Logger	LOGGER
private final Buffer	NEED_MORE_DATA_MESSAGE
private String	secret
private final Queue<ShutdownHandler>	shutdownHandlers

Access	Constructor and Description
public	AjpHandlerFilter()

Method Summary

Modifier and Type	Method and Description
public void	addShutdownHandler(final ShutdownHandler `ShutdownHandler` handler) Add the `ShutdownHandler`, which will be called, when shutdown request received.
public void	configure(final Properties properties) Configure Ajp Filter using properties.
private Buffer	encodeHttpPacket(final Connection<L> connection, final HttpPacket httpPacket)
private int	extractType(final FilterChainContext ctx, final Buffer buffer)
public String	Returns: not null, if only requests from workers with this secret keyword will be accepted, or null otherwise. getSecret() If not null, only requests from workers with this secret keyword will be accepted.
public NextAction	Returns: the `NextAction`. handleEvent(final FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. ctx, final FilterChainEvent the event triggering the invocation of this method. event) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent. Implements org.glassfish.grizzly.filterchain.Filter.handleEvent. Handling Http request completion event sent by Http server filter and send the Ajp end response message.
public NextAction	Returns: the `NextAction` handleRead(final FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Handle the Ajp message.
public NextAction	Returns: the `NextAction` handleWrite(final FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. ctx) Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Encoding HttpResponsePacket or HttpContent to Ajp message.
public boolean	Returns: true, if the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. isTomcatAuthentication() If set to true, the authentication will be done in Grizzly.
private NextAction	processCPing(final FilterChainContext ctx, final Buffer message) Process CPing request message.
private NextAction	processData(final FilterChainContext ctx, final Buffer messageContent)
private NextAction	Returns: `NextAction` processForwardRequest(final FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. ctx, final Buffer the content of the forwarded request content) Process ForwardRequest request message.
private NextAction	processShutdown(final FilterChainContext ctx, final Buffer message) Process Shutdown request message.
public void	removeShutdownHandler(final ShutdownHandler `ShutdownHandler` handler) Remove the `ShutdownHandler`.
private void	sendEndResponse(final FilterChainContext ctx)
private void	sendMoreDataRequestIfNeeded(final FilterChainContext ctx)
public void	setSecret(String if not null, only requests from workers with this secret keyword will be accepted. requiredSecret) If not null, only requests from workers with this secret keyword will be accepted.
public void	setTomcatAuthentication(boolean if true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. isTomcatAuthentication) /** If set to true, the authentication will be done in Grizzly.

Inherited from org.glassfish.grizzly.filterchain.BaseFilter:: createContext exceptionOccurred handleAccept handleClose handleConnect onAdded onFilterChainChanged onRemoved toString

httpRequestInProcessAttr	back to summary
private final Attribute<AjpHttpRequest> httpRequestInProcessAttr

isTomcatAuthentication	back to summary
private boolean isTomcatAuthentication

LOGGER	back to summary
private static final Logger LOGGER

NEED_MORE_DATA_MESSAGE	back to summary
private final Buffer NEED_MORE_DATA_MESSAGE

secret	back to summary
private String secret

shutdownHandlers	back to summary
private final Queue<ShutdownHandler> shutdownHandlers

AjpHandlerFilter	back to summary
public AjpHandlerFilter()

Method Detail

addShutdownHandler back to summary

addShutdownHandler	back to summary
public void addShutdownHandler(final ShutdownHandler handler) Add the `ShutdownHandler`, which will be called, when shutdown request received. Parameters handler:ShutdownHandler `ShutdownHandler`

public void addShutdownHandler(final ShutdownHandler handler)

Add the ShutdownHandler, which will be called, when shutdown request received.

Parameters

handler:ShutdownHandler: ShutdownHandler

configure	back to summary
public void configure(final Properties properties) Configure Ajp Filter using properties. We support following properties: request.useSecret, request.secret, tomcatAuthentication. Annotations @SuppressWarnings:UnusedDeclaration

configure

back to summary

public void configure(final Properties properties)

Configure Ajp Filter using properties. We support following properties: request.useSecret, request.secret, tomcatAuthentication.

Annotations

@SuppressWarnings:UnusedDeclaration

encodeHttpPacket	back to summary
private Buffer encodeHttpPacket(final Connection<L> connection, final HttpPacket httpPacket)

extractType	back to summary
private int extractType(final FilterChainContext ctx, final Buffer buffer)

getSecret	back to summary
public String getSecret() If not null, only requests from workers with this secret keyword will be accepted. Returns:String not null, if only requests from workers with this secret keyword will be accepted, or null otherwise. Annotations @SuppressWarnings:UnusedDeclaration

getSecret

back to summary

public String getSecret()

If not null, only requests from workers with this secret keyword will be accepted.

Returns:String

not null, if only requests from workers with this secret keyword will be accepted, or null otherwise.

Annotations

@SuppressWarnings:UnusedDeclaration

handleEvent back to summary

handleEvent	back to summary
public NextAction handleEvent(final FilterChainContext ctx, final FilterChainEvent event) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent. Implements org.glassfish.grizzly.filterchain.Filter.handleEvent. Handling Http request completion event sent by Http server filter and send the Ajp end response message. Parameters ctx:FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. event:FilterChainEvent the event triggering the invocation of this method. Returns:NextAction the `NextAction`. Annotations @Override Exceptions IOException: if an I/O error occurs.

public NextAction handleEvent(final FilterChainContext ctx, final FilterChainEvent event) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleEvent.

Implements org.glassfish.grizzly.filterchain.Filter.handleEvent.

Handling Http request completion event sent by Http server filter and send the Ajp end response message.

Parameters

ctx:FilterChainContext: the FilterChainContext for the current org.glassfish.grizzly.filterchain.FilterChain invocation.
event:FilterChainEvent: the event triggering the invocation of this method.

Returns:NextAction

the NextAction.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

handleRead back to summary

handleRead	back to summary
public NextAction handleRead(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead. Implements org.glassfish.grizzly.filterchain.Filter.handleRead. Handle the Ajp message. Parameters ctx:FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. Returns:NextAction the `NextAction` Annotations @Override Exceptions IOException: if an I/O error occurs

public NextAction handleRead(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleRead.

Implements org.glassfish.grizzly.filterchain.Filter.handleRead.

Handle the Ajp message.

Parameters

ctx:FilterChainContext: the FilterChainContext for the current org.glassfish.grizzly.filterchain.FilterChain invocation.

Returns:NextAction

the NextAction

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

handleWrite back to summary

handleWrite	back to summary
public NextAction handleWrite(final FilterChainContext ctx) throws IOException Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite. Implements org.glassfish.grizzly.filterchain.Filter.handleWrite. Encoding HttpResponsePacket or HttpContent to Ajp message. Parameters ctx:FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. Returns:NextAction the `NextAction` Annotations @Override Exceptions IOException: if an I/O error occurs

public NextAction handleWrite(final FilterChainContext ctx) throws IOException

Overrides org.glassfish.grizzly.filterchain.BaseFilter.handleWrite.

Implements org.glassfish.grizzly.filterchain.Filter.handleWrite.

Encoding HttpResponsePacket or HttpContent to Ajp message.

Parameters

ctx:FilterChainContext: the FilterChainContext for the current org.glassfish.grizzly.filterchain.FilterChain invocation.

Returns:NextAction

the NextAction

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

isTomcatAuthentication	back to summary
public boolean isTomcatAuthentication() If set to true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. The default value is true. Returns:boolean true, if the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. Annotations @SuppressWarnings:UnusedDeclaration

isTomcatAuthentication

back to summary

public boolean isTomcatAuthentication()

If set to true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. The default value is true.

Returns:boolean

true, if the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly.

Annotations

@SuppressWarnings:UnusedDeclaration

processCPing	back to summary
private NextAction processCPing(final FilterChainContext ctx, final Buffer message) throws IOException Process CPing request message. We send CPong response back as plain Grizzly `Buffer`.

processData	back to summary
private NextAction processData(final FilterChainContext ctx, final Buffer messageContent)

processForwardRequest back to summary

processForwardRequest	back to summary
private NextAction processForwardRequest(final FilterChainContext ctx, final Buffer content) throws IOException Process ForwardRequest request message. Parameters ctx:FilterChainContext the `FilterChainContext` for the current `org.glassfish.grizzly.filterchain.FilterChain` invocation. content:Buffer the content of the forwarded request Returns:NextAction `NextAction` Exceptions IOException: if an I/O error occurs

private NextAction processForwardRequest(final FilterChainContext ctx, final Buffer content) throws IOException

Process ForwardRequest request message.

Parameters

ctx:FilterChainContext: the FilterChainContext for the current org.glassfish.grizzly.filterchain.FilterChain invocation.
content:Buffer: the content of the forwarded request

Returns:NextAction

NextAction

Exceptions

IOException:: if an I/O error occurs

processShutdown	back to summary
private NextAction processShutdown(final FilterChainContext ctx, final Buffer message) Process Shutdown request message. For now just ignore it.

removeShutdownHandler back to summary

removeShutdownHandler	back to summary
public void removeShutdownHandler(final ShutdownHandler handler) Remove the `ShutdownHandler`. Parameters handler:ShutdownHandler `ShutdownHandler` Annotations @SuppressWarnings:UnusedDeclaration

public void removeShutdownHandler(final ShutdownHandler handler)

Remove the ShutdownHandler.

Parameters

handler:ShutdownHandler: ShutdownHandler

Annotations

@SuppressWarnings:UnusedDeclaration

sendEndResponse	back to summary
private void sendEndResponse(final FilterChainContext ctx) throws IOException

sendMoreDataRequestIfNeeded	back to summary
private void sendMoreDataRequestIfNeeded(final FilterChainContext ctx) throws IOException

setSecret	back to summary
public void setSecret(String requiredSecret) If not null, only requests from workers with this secret keyword will be accepted. Parameters requiredSecret:String if not null, only requests from workers with this secret keyword will be accepted.

setSecret

back to summary

public void setSecret(String requiredSecret)

If not null, only requests from workers with this secret keyword will be accepted.

Parameters

requiredSecret:String: if not null, only requests from workers with this secret keyword will be accepted.

setTomcatAuthentication	back to summary
public void setTomcatAuthentication(boolean isTomcatAuthentication) /** If set to true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. The default value is true. Parameters isTomcatAuthentication:boolean if true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly.

setTomcatAuthentication

back to summary

public void setTomcatAuthentication(boolean isTomcatAuthentication)

/** If set to true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly. The default value is true.

Parameters

isTomcatAuthentication:boolean: if true, the authentication will be done in Grizzly. Otherwise, the authenticated principal will be propagated from the native webserver and used for authorization in Grizzly.

public Class AjpHandlerFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail