DebugHttpTransportInterceptor (xdi2-transport-http 0.7.2 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractExtension<CONTAINER>
- - xdi2.messaging.target.interceptor.AbstractInterceptor<Transport<?,?>>
  - - xdi2.transport.impl.http.interceptor.impl.DebugHttpTransportInterceptor

All Implemented Interfaces:

xdi2.messaging.target.Extension<Transport<?,?>>, xdi2.messaging.target.interceptor.Interceptor<Transport<?,?>>, HttpTransportInterceptor, TransportInterceptor
```
public class DebugHttpTransportInterceptor
extends xdi2.messaging.target.interceptor.AbstractInterceptor<Transport<?,?>>
implements TransportInterceptor, HttpTransportInterceptor
```
This interceptor prints out a list of mounted messaging targets. This can be used for debugging purposes with a standard web browser.

Author:

markus

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DebugHttpTransportInterceptor.LogEntry
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Extension
  xdi2.messaging.target.Extension.InitPriorityComparator, xdi2.messaging.target.Extension.ShutdownPriorityComparator

Nested Classes
Modifier and Type	Class and Description
`static class`	`DebugHttpTransportInterceptor.LogEntry`

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_LOG_CAPACITY

static String DEFAULT_PATH
- Fields inherited from class xdi2.messaging.target.impl.AbstractExtension
  DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_LOG_CAPACITY`
`static String`	`DEFAULT_PATH`

Constructor Summary

Constructors
Constructor and Description

DebugHttpTransportInterceptor()

Constructors
Constructor and Description
`DebugHttpTransportInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`after(Transport<?,?> transport, Request request, Response response, xdi2.messaging.target.MessagingTarget messagingTarget, xdi2.messaging.MessageEnvelope messageEnvelope, xdi2.messaging.MessageResult messageResult, xdi2.messaging.context.ExecutionContext executionContext)`
`boolean`	`before(Transport<?,?> transport, Request request, Response response, xdi2.messaging.target.MessagingTarget messagingTarget, xdi2.messaging.MessageEnvelope messageEnvelope, xdi2.messaging.MessageResult messageResult, xdi2.messaging.context.ExecutionContext executionContext)`
`void`	`exception(Transport<?,?> transport, Request request, Response response, xdi2.messaging.target.MessagingTarget messagingTarget, xdi2.messaging.MessageEnvelope messageEnvelope, xdi2.messaging.error.ErrorMessageResult errorMessageResult, xdi2.messaging.context.ExecutionContext executionContext, Exception ex)`
`LinkedList<DebugHttpTransportInterceptor.LogEntry>`	`getLog()`
`int`	`getLogCapacity()`
`String`	`getPath()`
`static Date`	`getStart(xdi2.messaging.context.ExecutionContext executionContext)`
`boolean`	`processDeleteRequest(HttpTransport httpTransport, HttpRequest request, HttpResponse response, MessagingTargetMount messagingTargetMount)` Run when the HTTP transport receives a DELETE request.
`boolean`	`processGetRequest(HttpTransport httpTransport, HttpRequest request, HttpResponse response, MessagingTargetMount messagingTargetMount)` Run when the HTTP transport receives a GET request.
`boolean`	`processPostRequest(HttpTransport httpTransport, HttpRequest request, HttpResponse response, MessagingTargetMount messagingTargetMount)` Run when the HTTP transport receives a POST request.
`boolean`	`processPutRequest(HttpTransport httpTransport, HttpRequest request, HttpResponse response, MessagingTargetMount messagingTargetMount)` Run when the HTTP transport receives a PUT request.
`static void`	`putStart(xdi2.messaging.context.ExecutionContext executionContext, Date start)`
`void`	`setLog(LinkedList<DebugHttpTransportInterceptor.LogEntry> log)`
`void`	`setLogCapacity(int logCapacity)`
`void`	`setPath(String path)`

Methods inherited from class xdi2.messaging.target.impl.AbstractExtension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdi2.messaging.target.Extension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Field Detail
- DEFAULT_PATH
```
public static final String DEFAULT_PATH
```
  See Also:
  Constant Field Values
- DEFAULT_LOG_CAPACITY
```
public static final int DEFAULT_LOG_CAPACITY
```
  See Also:
  Constant Field Values

Constructor Detail
- DebugHttpTransportInterceptor
```
public DebugHttpTransportInterceptor()
```

Method Detail

before

public boolean before(Transport<?,?> transport,
             Request request,
             Response response,
             xdi2.messaging.target.MessagingTarget messagingTarget,
             xdi2.messaging.MessageEnvelope messageEnvelope,
             xdi2.messaging.MessageResult messageResult,
             xdi2.messaging.context.ExecutionContext executionContext)
               throws Xdi2TransportException

Specified by:: before in interface TransportInterceptor
Throws:: Xdi2TransportException

after

public boolean after(Transport<?,?> transport,
            Request request,
            Response response,
            xdi2.messaging.target.MessagingTarget messagingTarget,
            xdi2.messaging.MessageEnvelope messageEnvelope,
            xdi2.messaging.MessageResult messageResult,
            xdi2.messaging.context.ExecutionContext executionContext)
              throws Xdi2TransportException

Specified by:: after in interface TransportInterceptor
Throws:: Xdi2TransportException

exception

public void exception(Transport<?,?> transport,
             Request request,
             Response response,
             xdi2.messaging.target.MessagingTarget messagingTarget,
             xdi2.messaging.MessageEnvelope messageEnvelope,
             xdi2.messaging.error.ErrorMessageResult errorMessageResult,
             xdi2.messaging.context.ExecutionContext executionContext,
             Exception ex)

Specified by:: exception in interface TransportInterceptor

processPostRequest

public boolean processPostRequest(HttpTransport httpTransport,
                         HttpRequest request,
                         HttpResponse response,
                         MessagingTargetMount messagingTargetMount)
                           throws Xdi2TransportException,
                                  IOException

Description copied from interface: HttpTransportInterceptor

Run when the HTTP transport receives a POST request.

Specified by:: processPostRequest in interface HttpTransportInterceptor
Returns:: True, if the request has been fully handled.
Throws:: Xdi2TransportException; IOException

processGetRequest

public boolean processGetRequest(HttpTransport httpTransport,
                        HttpRequest request,
                        HttpResponse response,
                        MessagingTargetMount messagingTargetMount)
                          throws Xdi2TransportException,
                                 IOException

Description copied from interface: HttpTransportInterceptor

Run when the HTTP transport receives a GET request.

Specified by:: processGetRequest in interface HttpTransportInterceptor
Returns:: True, if the request has been fully handled.
Throws:: Xdi2TransportException; IOException

processPutRequest

public boolean processPutRequest(HttpTransport httpTransport,
                        HttpRequest request,
                        HttpResponse response,
                        MessagingTargetMount messagingTargetMount)
                          throws Xdi2TransportException,
                                 IOException

Description copied from interface: HttpTransportInterceptor

Run when the HTTP transport receives a PUT request.

Specified by:: processPutRequest in interface HttpTransportInterceptor
Returns:: True, if the request has been fully handled.
Throws:: Xdi2TransportException; IOException

processDeleteRequest

public boolean processDeleteRequest(HttpTransport httpTransport,
                           HttpRequest request,
                           HttpResponse response,
                           MessagingTargetMount messagingTargetMount)
                             throws Xdi2TransportException,
                                    IOException

Description copied from interface: HttpTransportInterceptor

Run when the HTTP transport receives a DELETE request.

Specified by:: processDeleteRequest in interface HttpTransportInterceptor
Returns:: True, if the request has been fully handled.
Throws:: Xdi2TransportException; IOException

getPath
```
public String getPath()
```

setPath
```
public void setPath(String path)
```

getLogCapacity
```
public int getLogCapacity()
```

setLogCapacity

public void setLogCapacity(int logCapacity)

getLog

public LinkedList<DebugHttpTransportInterceptor.LogEntry> getLog()

setLog

public void setLog(LinkedList<DebugHttpTransportInterceptor.LogEntry> log)

getStart

public static Date getStart(xdi2.messaging.context.ExecutionContext executionContext)

putStart

public static void putStart(xdi2.messaging.context.ExecutionContext executionContext,
            Date start)

Class DebugHttpTransportInterceptor

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.target.Extension

Field Summary

Fields inherited from class xdi2.messaging.target.impl.AbstractExtension

Constructor Summary

Method Summary

Methods inherited from class xdi2.messaging.target.impl.AbstractExtension

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.messaging.target.Extension

Field Detail

DEFAULT_PATH

DEFAULT_LOG_CAPACITY

Constructor Detail

DebugHttpTransportInterceptor

Method Detail

before

after

exception

processPostRequest

processGetRequest

processPutRequest

processDeleteRequest

getPath

setPath

getLogCapacity

setLogCapacity

getLog

setLog

getStart

putStart