StringACLCodec

java.lang.Object
- jade.lang.acl.StringACLCodec

All Implemented Interfaces:

ACLCodec
```
public class StringACLCodec
extends Object
implements ACLCodec
```
This class implements the FIPA String codec for ACLMessages. Notice that it is not possible to convey a sequence of bytes over a StringACLCodec because the bytes with the 8th bit ON cannot properly converted into a char.

Version:

0.9

Author:

Fabio Bellifemine - CSELT S.p.A., Nicolas Lhuillier - Motorola

Nested Class Summary
- Nested classes/interfaces inherited from interface jade.lang.acl.ACLCodec
  ACLCodec.CodecException

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`BASE64ENCODING_KEY` Key of the user-defined parameter used to signal the automatic JADE conversion of the content into Base64 encoding
`private static String`	`BASE64ENCODING_VALUE` Value of the user-defined parameter used to signal the automatic JADE conversion of the content into Base64 encoding
`private static String`	`CONTENT`
`private static String`	`CONVERSATION_ID`
`private static String`	`ENCODING`
`private static String`	`illegalFirstChar`
`private static String`	`IN_REPLY_TO`
`private static String`	`LANGUAGE`
`static String`	`NAME` String constant for the name of the ACL representation managed by this ACL codec.
`private static String`	`ONTOLOGY`
`(package private) Writer`	`out`
`(package private) ACLParser`	`parser`
`private static String`	`PROTOCOL`
`private static String`	`RECEIVER`
`private static String`	`REPLY_BY`
`private static String`	`REPLY_TO`
`private static String`	`REPLY_WITH`
`private static String`	`SENDER`

Fields inherited from interface jade.lang.acl.ACLCodec
DEFAULT_CHARSET

Constructor Summary

Constructors
Constructor and Description

StringACLCodec()
constructor for the codec.

StringACLCodec(Reader r, Writer w)
constructor for the codec.

Constructors
Constructor and Description
`StringACLCodec()` constructor for the codec.
`StringACLCodec(Reader r, Writer w)` constructor for the codec.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendACLExpression(StringBuffer str, String slotName, String slotValue)` append to the passed StringBuffer the slot name and value separated by a blank char and followed by a newline.
`private void`	`checkBase64Encoding(ACLMessage msg)` if there was an automatical Base64 encoding, then it performs automatic decoding.
`ACLMessage`	`decode()` decode and parses the next message from the Reader passed in the constructor.
`ACLMessage`	`decode(byte[] data, String charset)` Recovers an `ACLMessage` object back from raw data, using the specific message representation to interpret the byte sequence.
`AID`	`decodeAID()` Parse an agent identifier, without it being included within an ACL message.
`byte[]`	`encode(ACLMessage msg, String charset)` If the content of the message is a byteSequence, then this method encodes the content in Base64 and automatically sets the value of the encoding slot.
`private static String`	`escape(String s)`
`String`	`getName()` Query the name of the message representation handled by this `Codec` object.
`private static boolean`	`isAWord(String s)` Test if the given string is a legal word using the FIPA ACL spec.
`private static String`	`quotedString(String str)` Take a java String and quote it to form a legal FIPA ACL string.
`(package private) static String`	`toString(ACLMessage msg)` If a user-defined parameter contain a blank char inside, then it is skipped for FIPA-compatibility
`void`	`write(ACLMessage msg)` encodes the message and writes it into the Writer passed in the constructor.

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

- Field Detail
  - NAME
```
public static final String NAME
```
    String constant for the name of the ACL representation managed by this ACL codec.
    
    See Also:
    
    Constant Field Values
  - BASE64ENCODING_KEY
```
private static final String BASE64ENCODING_KEY
```
    Key of the user-defined parameter used to signal the automatic JADE conversion of the content into Base64 encoding
    
    See Also:
    
    Constant Field Values
  - BASE64ENCODING_VALUE
```
private static final String BASE64ENCODING_VALUE
```
    Value of the user-defined parameter used to signal the automatic JADE conversion of the content into Base64 encoding
    
    See Also:
    
    Constant Field Values
  - SENDER
```
private static final String SENDER
```
    See Also:
    
    Constant Field Values
  - RECEIVER
```
private static final String RECEIVER
```
    See Also:
    
    Constant Field Values
  - CONTENT
```
private static final String CONTENT
```
    See Also:
    
    Constant Field Values
  - REPLY_WITH
```
private static final String REPLY_WITH
```
    See Also:
    
    Constant Field Values
  - IN_REPLY_TO
```
private static final String IN_REPLY_TO
```
    See Also:
    
    Constant Field Values
  - REPLY_TO
```
private static final String REPLY_TO
```
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
private static final String LANGUAGE
```
    See Also:
    
    Constant Field Values
  - ENCODING
```
private static final String ENCODING
```
    See Also:
    
    Constant Field Values
  - ONTOLOGY
```
private static final String ONTOLOGY
```
    See Also:
    
    Constant Field Values
  - REPLY_BY
```
private static final String REPLY_BY
```
    See Also:
    
    Constant Field Values
  - PROTOCOL
```
private static final String PROTOCOL
```
    See Also:
    
    Constant Field Values
  - CONVERSATION_ID
```
private static final String CONVERSATION_ID
```
    See Also:
    
    Constant Field Values
  - parser
```
ACLParser parser
```
  - out
```
Writer out
```
  - illegalFirstChar
```
private static final String illegalFirstChar
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringACLCodec
```
public StringACLCodec()
```
    constructor for the codec. The standard input is used as an input stream of ACL messages. The standard output is used to write encoded ACL messages.
  - StringACLCodec
```
public StringACLCodec(Reader r,
                      Writer w)
```
    constructor for the codec.
- Method Detail
  - checkBase64Encoding
```
private void checkBase64Encoding(ACLMessage msg)
```
    if there was an automatical Base64 encoding, then it performs automatic decoding.
  - decode
```
public ACLMessage decode()
                  throws ACLCodec.CodecException
```
    decode and parses the next message from the Reader passed in the constructor.
    
    Returns:
    
    the ACLMessage
    
    Throws:
    
    ACLCodec.CodecException - if any Exception occurs during the parsing/reading operation
  - decodeAID
```
public AID decodeAID()
              throws ACLCodec.CodecException
```
    Parse an agent identifier, without it being included within an ACL message.
    
    Throws:
    
    ACLCodec.CodecException
  - write
```
public void write(ACLMessage msg)
```
    encodes the message and writes it into the Writer passed in the constructor. Notice that this method does not call flush on the writer.
  - escape
```
private static String escape(String s)
```
  - quotedString
```
private static String quotedString(String str)
```
    Take a java String and quote it to form a legal FIPA ACL string. Add quotation marks to the beginning/end and escape any quotation marks inside the string.
  - toString
```
static String toString(ACLMessage msg)
```
    If a user-defined parameter contain a blank char inside, then it is skipped for FIPA-compatibility
    
    Returns:
    
    a String encoded message
    
    See Also:
    
    ACLMessage.toString()
  - encode
```
public byte[] encode(ACLMessage msg,
                     String charset)
```
    If the content of the message is a byteSequence, then this method encodes the content in Base64 and automatically sets the value of the encoding slot.
    
    Specified by:
    
    encode in interface ACLCodec
    
    Parameters:
    
    msg - The ACL message to encode.
    
    charset - Charset encoding to use (e.g. US_ASCII, UTF-8, etc)
    
    Returns:
    
    a byte array, containing the encoded message.
    
    See Also:
    
    ACLCodec#encode(ACLMessage msg)
  - decode
```
public ACLMessage decode(byte[] data,
                         String charset)
                  throws ACLCodec.CodecException
```
    Description copied from interface: ACLCodec
    
    Recovers an ACLMessage object back from raw data, using the specific message representation to interpret the byte sequence.
    
    Specified by:
    
    decode in interface ACLCodec
    
    Parameters:
    
    data - The byte sequence containing the encoded message.
    
    charset - Charset encoding to use (e.g. US_ASCII, UTF-8, etc)
    
    Returns:
    
    A new ACLMessage object, built from the raw data.
    
    Throws:
    
    ACLCodec.CodecException - If some kind of syntax error occurs.
    
    See Also:
    
    ACLCodec#decode(byte[] data)
  - getName
```
public String getName()
```
    Description copied from interface: ACLCodec
    
    Query the name of the message representation handled by this Codec object. The FIPA standard representations have a name starting with "fipa.acl.rep.".
    
    Specified by:
    
    getName in interface ACLCodec
    
    Returns:
    
    the name of this encoding according to the FIPA specifications
  - appendACLExpression
```
public static void appendACLExpression(StringBuffer str,
                                       String slotName,
                                       String slotValue)
```
    append to the passed StringBuffer the slot name and value separated by a blank char and followed by a newline. If the value contains a blank, then it is quoted. if the value is null or its length is zero, the method does nothing.
  - isAWord
```
private static boolean isAWord(String s)
```
    Test if the given string is a legal word using the FIPA ACL spec. In addition to FIPA's restrictions, place the additional restriction that a Word can not contain a '\"', that would confuse the parser at the other end.

Class StringACLCodec

Nested Class Summary

Nested classes/interfaces inherited from interface jade.lang.acl.ACLCodec

Field Summary

Fields inherited from interface jade.lang.acl.ACLCodec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

BASE64ENCODING_KEY

BASE64ENCODING_VALUE

SENDER

RECEIVER

CONTENT

REPLY_WITH

IN_REPLY_TO

REPLY_TO

LANGUAGE

ENCODING

ONTOLOGY

REPLY_BY

PROTOCOL

CONVERSATION_ID

parser

out

illegalFirstChar

Constructor Detail

StringACLCodec

StringACLCodec

Method Detail

checkBase64Encoding

decode

decodeAID

write

escape

quotedString

toString

encode

decode

getName

appendACLExpression

isAWord