ProtocolMessages (JBoss Application Server: Parent Aggregator 7.1.1.Final API)

@MessageBundle(projectCode="JBAS")
public interface ProtocolMessages

Date: 21.07.2011

Author:: James R. Perkins

Field Summary

Fields
Modifier and Type Field and Description

static ProtocolMessages MESSAGES
The default messages.

Fields
Modifier and Type	Field and Description
`static ProtocolMessages`	`MESSAGES` The default messages.

Method Summary

Methods
Modifier and Type	Method and Description
`IllegalStateException`	`alreadyConnected()` Creates an exception indicating a connection is already connected.
`IllegalStateException`	`alreadyStarted()` Creates an exception indicating the channel and receiver have already been started.
`IllegalArgumentException`	`cannotSetUriScheme()` Creates an exception indicating the uriScheme cannot be set with the endpoint.
`IllegalArgumentException`	`cannotSpecifyMultipleTimeouts()` Creates an exception indicating that both connect timeout and the connect timeout property cannot be used together.
`ConnectException`	`couldNotConnect(long connectionTimeout)` Creates an exception indicating a connection could not be made.
`ConnectException`	`couldNotConnect(URI uri, long timeout, String timeoutProperty)` Creates an exception indicating a connection could not be made.
`IllegalArgumentException`	`executorNeeded()` Creates an exception indicating the executor is needed when not endpoint is specified.
`IllegalArgumentException`	`executorUnneeded()` Creates an exception indicating the executor is not needed when an endpoint is specified.
`IOException`	`failedToCreateServerThread()` Creates an exception indicating a failure to create the server thread.
`IOException`	`failedToReadObject(Throwable cause)` Creates an exception indicating a failure to read the object.
`IOException`	`failedToWriteManagementResponseHeaders(Throwable cause)` Creates an exception indicating a failure to write management response headers.
`UTFDataFormatException`	`invalidByte()` Creates an exception indicating an invalid byte.
`UTFDataFormatException`	`invalidByte(char c, int i)` Creates an exception indicating an invalid byte.
`IOException`	`invalidByteToken(int expected, byte actual)` Creates an exception indicating an invalid byte token was found.
`IOException`	`invalidCommandByte(int commandByte)` Creates an exception indicating the an invalid command byte was read.
`IOException`	`invalidSignature(String signature)` Creates an exception indicating the signature is invalid.
`IOException`	`invalidStartChunk(int chunk)` Creates an exception indicating an invalid start chunk was found.
`IOException`	`invalidType(String type)` Creates an exception indicating the type is invalid.
`IllegalArgumentException`	`invalidType(String validType1, String validType2, byte providedType)` Creates an exception indicating the provided type was invalid.
`IllegalArgumentException`	`invalidUrl(String url)` Creates an exception indicating only the `url` is a valid URL.
`IllegalStateException`	`notConnected()` Creates an exception indicating there is no connection.
`IllegalArgumentException`	`nullParameters(String parameterName1, String parameterName2)` Creates an exception indicating the `parameterName1` and `parameterName2` are `null`.
`IllegalArgumentException`	`nullVar(String varName)` Creates an exception indicating the `varName` is `null`.
`IOException`	`operationHandlerNotSet()` Creates an exception indicating there is no operation handler set.
`EOFException`	`readBytes(int bytesRead)` Creates an exception indicating the number of bytes read.
`IOException`	`responseHandlerAlreadyRegistered()` Creates an exception indicating the response handler has already been registered for the request.
`IOException`	`responseHandlerNotFound(int id)` Creates an exception indicating the response handler id was not found for the request.
`IOException`	`serverError(String errorMessage)` Creates an exception indicating a problem happened executing on the server.
`IOException`	`streamClosed()` Creates an exception indicating the stream is closed.
`IllegalStateException`	`threadCreationRefused()` Creates an exception indicating the thread creation was refused.
`EOFException`	`unexpectedEndOfStream()` Creates an exception indicating the an unexpected end of stream was detected.
`IllegalArgumentException`	`unmatchedScheme(String scheme, URI uri)` Creates an exception indicating the scheme does not match the URI.
`IOException`	`writeChannelClosed()` Creates an exception indicating the write channel is closed.
`IOException`	`writesAlreadyShutdown()` Creates an exception indicating the writes have already been shutdown.

- Field Detail
  - MESSAGES
```
static final ProtocolMessages MESSAGES
```
    The default messages.
- Method Detail
  - alreadyConnected
```
@Message(value="Already connected")
IllegalStateException alreadyConnected()
```
    Creates an exception indicating a connection is already connected.
    
    Returns:
    an IllegalStateException for the error.
  - alreadyStarted
```
@Message(value="Channel and receiver already started")
IllegalStateException alreadyStarted()
```
    Creates an exception indicating the channel and receiver have already been started.
    
    Returns:
    an IllegalStateException for the error.
  - cannotSpecifyMultipleTimeouts
```
@Message(value="Can\'t use both a connect timeout and a connect timeout property")
IllegalArgumentException cannotSpecifyMultipleTimeouts()
```
    Creates an exception indicating that both connect timeout and the connect timeout property cannot be used together.
    
    Returns:
    an IllegalArgumentException for the error.
  - cannotSetUriScheme
```
@Message(value="Can\'t set uriScheme with specified endpoint")
IllegalArgumentException cannotSetUriScheme()
```
    Creates an exception indicating the uriScheme cannot be set with the endpoint.
    
    Returns:
    an IllegalArgumentException for the error.
  - couldNotConnect
```
@Message(value="Could not connect to %s in %sms. Make sure the server is running and/or consider setting a longer timeout by setting -D%s=.")
ConnectException couldNotConnect(URI uri,
                                       long timeout,
                                       String timeoutProperty)
```
    Creates an exception indicating a connection could not be made.
    
    Parameters:
    uri - the URI attempted to connect.
    timeout - the timeout of the connection.
    timeoutProperty - the timeout property name.
    
    Returns:
    a ConnectException for the error.
  - couldNotConnect
```
@Message(value="Could not connect to remote server at %1$s within %1$sms")
ConnectException couldNotConnect(long connectionTimeout)
```
    Creates an exception indicating a connection could not be made.
    
    Parameters:
    connectionTimeout - the connection timeout
    
    Returns:
    a ConnectException for the error.
  - executorNeeded
```
@Message(value="Need an executor when endpoint is not specified")
IllegalArgumentException executorNeeded()
```
    Creates an exception indicating the executor is needed when not endpoint is specified.
    
    Returns:
    an IllegalArgumentException for the error.
  - executorUnneeded
```
@Message(value="Don\'t need an executor when specified endpoint")
IllegalArgumentException executorUnneeded()
```
    Creates an exception indicating the executor is not needed when an endpoint is specified.
    
    Returns:
    an IllegalArgumentException for the error.
  - failedToCreateServerThread
```
@Message(value="Failed to create server thread")
IOException failedToCreateServerThread()
```
    Creates an exception indicating a failure to create the server thread.
    
    Returns:
    an IOException for the error.
  - failedToReadObject
```
@Message(value="Failed to read object")
IOException failedToReadObject(@Cause
                                     Throwable cause)
```
    Creates an exception indicating a failure to read the object.
    
    Parameters:
    cause - the cause of the error.
    
    Returns:
    an IOException for the error.
  - failedToWriteManagementResponseHeaders
```
@Message(value="Failed to write management response headers")
IOException failedToWriteManagementResponseHeaders(@Cause
                                                         Throwable cause)
```
    Creates an exception indicating a failure to write management response headers.
    
    Parameters:
    cause - the cause of the error.
    
    Returns:
    an IOException for the error.
  - invalidByte
```
@Message(value="Invalid byte")
UTFDataFormatException invalidByte()
```
    Creates an exception indicating an invalid byte.
    
    Returns:
    an UTFDataFormatException for the error.
  - invalidByte
```
@Message(value="Invalid byte:%s(%d)")
UTFDataFormatException invalidByte(char c,
                                         int i)
```
    Creates an exception indicating an invalid byte.
    
    Parameters:
    c - the character.
    i - the raw integer.
    
    Returns:
    an UTFDataFormatException for the error.
  - invalidByteToken
```
@Message(value="Invalid byte token.  Expecting \'%s\' received \'%s\'")
IOException invalidByteToken(int expected,
                                   byte actual)
```
    Creates an exception indicating an invalid byte token was found.
    
    Parameters:
    expected - the expected value.
    actual - the actual value.
    
    Returns:
    an IOException for the error.
  - invalidCommandByte
```
@Message(value="Invalid command byte read: %s")
IOException invalidCommandByte(int commandByte)
```
    Creates an exception indicating the an invalid command byte was read.
    
    Parameters:
    commandByte - the command byte read.
    
    Returns:
    an IOException for the error.
  - invalidSignature
```
@Message(value="Invalid signature [%s]")
IOException invalidSignature(String signature)
```
    Creates an exception indicating the signature is invalid.
    
    Parameters:
    signature - the invalid signature.
    
    Returns:
    an IOException for the error.
  - invalidStartChunk
```
@Message(value="Invalid start chunk start [%s]")
IOException invalidStartChunk(int chunk)
```
    Creates an exception indicating an invalid start chunk was found.
    
    Parameters:
    chunk - the start chunk.
    
    Returns:
    an IOException for the error.
  - invalidType
```
@Message(value="Invalid type: %s")
IOException invalidType(String type)
```
    Creates an exception indicating the type is invalid.
    
    Parameters:
    type - the invalid type.
    
    Returns:
    an IOException for the error.
  - invalidType
```
@Message(value="Type is neither %s or %s: %s")
IllegalArgumentException invalidType(String validType1,
                                           String validType2,
                                           byte providedType)
```
    Creates an exception indicating the provided type was invalid.
    
    Parameters:
    validType1 - the first valid type.
    validType2 - the second valid type.
    providedType - the type provided.
    
    Returns:
    an IllegalArgumentException for the error.
  - invalidUrl
```
@Message(value="Only \'%s\' is a valid url")
IllegalArgumentException invalidUrl(String url)
```
    Creates an exception indicating only the url is a valid URL.
    
    Parameters:
    url - the valid url.
    
    Returns:
    an IllegalArgumentException for the error.
  - operationHandlerNotSet
```
@Message(value="No operation handler set")
IOException operationHandlerNotSet()
```
    Creates an exception indicating there is no operation handler set.
    
    Returns:
    an IOException for the error.
  - notConnected
```
@Message(value="Not connected")
IllegalStateException notConnected()
```
    Creates an exception indicating there is no connection.
    
    Returns:
    an IllegalStateException for the error.
  - nullVar
```
@Message(value="%s is null")
IllegalArgumentException nullVar(String varName)
```
    Creates an exception indicating the varName is null.
    
    Parameters:
    varName - the variable name.
    
    Returns:
    an IllegalArgumentException for the error.
  - nullParameters
```
@Message(value="%s and %s are null")
IllegalArgumentException nullParameters(String parameterName1,
                                              String parameterName2)
```
    Creates an exception indicating the parameterName1 and parameterName2 are null.
    
    Parameters:
    parameterName1 - the parameter name.
    parameterName2 - the parameter name.
    
    Returns:
    an IllegalArgumentException for the error.
  - readBytes
```
@Message(value="Read %d bytes.")
EOFException readBytes(int bytesRead)
```
    Creates an exception indicating the number of bytes read.
    
    Parameters:
    bytesRead - the number of bytes read.
    
    Returns:
    an EOFException for the error.
  - responseHandlerAlreadyRegistered
```
@Message(value="Response handler already registered for request")
IOException responseHandlerAlreadyRegistered()
```
    Creates an exception indicating the response handler has already been registered for the request.
    
    Returns:
    an IOException for the error.
  - responseHandlerNotFound
```
@Message(value="No response handler for request %s")
IOException responseHandlerNotFound(int id)
```
    Creates an exception indicating the response handler id was not found for the request.
    
    Parameters:
    id - the id.
    
    Returns:
    an IOException for the error.
  - serverError
```
@Message(value="A problem happened executing on the server: %s")
IOException serverError(String errorMessage)
```
    Creates an exception indicating a problem happened executing on the server.
    
    Parameters:
    errorMessage - the error message.
    
    Returns:
    an IOException for the error
  - streamClosed
```
@Message(value="Stream closed")
IOException streamClosed()
```
    Creates an exception indicating the stream is closed.
    
    Returns:
    an IOException for the error.
  - threadCreationRefused
```
@Message(value="Thread creation was refused")
IllegalStateException threadCreationRefused()
```
    Creates an exception indicating the thread creation was refused.
    
    Returns:
    an IllegalStateException for the error.
  - unexpectedEndOfStream
```
@Message(value="Unexpected end of stream")
EOFException unexpectedEndOfStream()
```
    Creates an exception indicating the an unexpected end of stream was detected.
    
    Returns:
    an EOFException for the error.
  - unmatchedScheme
```
@Message(value="Scheme %s does not match uri %s")
IllegalArgumentException unmatchedScheme(String scheme,
                                               URI uri)
```
    Creates an exception indicating the scheme does not match the URI.
    
    Parameters:
    scheme - the scheme.
    uri - the uri.
    
    Returns:
    an IllegalArgumentException for the error.
  - writeChannelClosed
```
@Message(value="Write channel closed")
IOException writeChannelClosed()
```
    Creates an exception indicating the write channel is closed.
    
    Returns:
    an IOException for the error.
  - writesAlreadyShutdown
```
@Message(value="Writes are already shut down")
IOException writesAlreadyShutdown()
```
    Creates an exception indicating the writes have already been shutdown.
    
    Returns:
    an IOException for the error.

Interface ProtocolMessages

Field Summary

Method Summary

Field Detail

MESSAGES

Method Detail

alreadyConnected

alreadyStarted

cannotSpecifyMultipleTimeouts

cannotSetUriScheme

couldNotConnect

couldNotConnect

executorNeeded

executorUnneeded

failedToCreateServerThread

failedToReadObject

failedToWriteManagementResponseHeaders

invalidByte

invalidByte

invalidByteToken

invalidCommandByte

invalidSignature

invalidStartChunk

invalidType

invalidType

invalidUrl

operationHandlerNotSet

notConnected

nullVar

nullParameters

readBytes

responseHandlerAlreadyRegistered

responseHandlerNotFound

serverError

streamClosed

threadCreationRefused

unexpectedEndOfStream

unmatchedScheme

writeChannelClosed

writesAlreadyShutdown