|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientDataEncoder
A service used when a component or service needs to encode some amount of data on the client as a string. The string may be a query parameter, hidden form field, or a portion of a URL. The default implementation converts the object output stream into a Base64 string.
Starting in release 5.3.6, the encoded data incorporates an HMAC (hash based message authentication code) signature, as a prefix. HMAC requires a secret key, configured using theSymbolConstants.HMAC_PASSPHRASE
symbol.
Method Summary | |
---|---|
ClientDataSink |
createSink()
Creates a sink for client data. |
java.io.ObjectInputStream |
decodeClientData(java.lang.String clientData)
Decodes data previously obtained from ClientDataSink.getClientData() . |
java.io.ObjectInputStream |
decodeEncodedClientData(java.lang.String clientData)
Decodes client data obtained via ClientDataSink.getEncodedClientData() . |
Method Detail |
---|
ClientDataSink createSink()
java.io.ObjectInputStream decodeClientData(java.lang.String clientData) throws java.io.IOException
ClientDataSink.getClientData()
.
clientData
- encoded client data
java.io.IOException
- if the client data has been corrupted (verified via the HMAC)java.io.ObjectInputStream decodeEncodedClientData(java.lang.String clientData) throws java.io.IOException
ClientDataSink.getEncodedClientData()
.
clientData
- URLEncoded client data
java.io.IOException
- if the client data has been corrupted (verified via the HMAC)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |