Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface TextEncoders

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CMEncoder

public interface TextEncoders
extends CMLibrary

Text/String encoders and decoders. Some encrypters, hashers, that sort of thing.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
byte[]	compressString(java.lang.String s)	Compress a string into a binary data buffer.
java.lang.String	decompressString(byte[] b)	Decompress a string from a binary data buffer.
java.lang.String	filterDecrypt(java.lang.String str)	Decrypts a weakly encrypted string.
java.lang.String	filterEncrypt(java.lang.String str)	Weakly encrypts a string.
java.lang.String	generateRandomPassword()	Generates a random 10 char password string.
java.lang.String	makeFinalPasswordString(java.lang.String rawPassword)	Checks whether hash passwords are used, and if so, hashes the password and returns the encoded string, and otherwise, just returns the raw password back.
java.lang.String	makeRepeatableHashString(java.lang.String str)	Hashes the given string and returns an encoding of it.
boolean	passwordCheck(java.lang.String pass1, java.lang.String pass2)	Compares two passwords to see if they are the same.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

decompressString

java.lang.String decompressString(byte[] b)

Decompress a string from a binary data buffer.

Parameters:

b - the compressed data buffer

Returns:

the uncompressed string

See Also:

compressString(String)

compressString

byte[] compressString(java.lang.String s)

Compress a string into a binary data buffer.

Parameters:

s - the uncompressed string

Returns:

the compressed data buffer

See Also:

decompressString(byte[])

makeFinalPasswordString

java.lang.String makeFinalPasswordString(java.lang.String rawPassword)

Checks whether hash passwords are used, and if so, hashes the password and returns the encoded string, and otherwise, just returns the raw password back.

Parameters:

rawPassword - the raw password straight from the user

Returns:

the final password to store

passwordCheck

boolean passwordCheck(java.lang.String pass1,
                      java.lang.String pass2)

Compares two passwords to see if they are the same. It does not matter which is which, or which is encoded and which is not, or anything else. This Just Works.

Parameters:

pass1 - one of the passwords

pass2 - the other password

Returns:

true if they match, false otherwise

generateRandomPassword

java.lang.String generateRandomPassword()

Generates a random 10 char password string. Not encoded or anything.

Returns:

a random password string

makeRepeatableHashString

java.lang.String makeRepeatableHashString(java.lang.String str)

Hashes the given string and returns an encoding of it.

Parameters:

str - the string to encode

Returns:

the encoded string

filterDecrypt

java.lang.String filterDecrypt(java.lang.String str)

Decrypts a weakly encrypted string.

Parameters:

str - the string to decrypt

Returns:

the original string

See Also:

filterEncrypt(String), filterDecrypt(String)

filterEncrypt

java.lang.String filterEncrypt(java.lang.String str)

Weakly encrypts a string.

Parameters:

str - the string to encrypt

Returns:

the encrypted string

See Also:

filterDecrypt(String)