sandmark.watermark.constantstring
Class ConstantString

java.lang.Object
  |
  +--sandmark.Algorithm
        |
        +--sandmark.watermark.GeneralWatermarker
              |
              +--sandmark.watermark.StaticWatermarker
                    |
                    +--sandmark.watermark.constantstring.ConstantString

public class ConstantString

extends StaticWatermarker

This algorithm adds a constant "sm$watermark=WATERMARK" to the constant pool of a random class. "WATERMARK" is the actual watermark value, sm$watermark is the identifer we're looking for during recognition.

Nested Class Summary

(package private) class

ConstantString.Recognizer

Field Summary

(package private) static ConfigProperties

configProps

Constructor Summary

ConstantString()
Constructs a watermarker.

Method Summary

void	embed(ClassFileCollection cfc, java.util.jar.JarOutputStream output, java.util.Properties props) Embed a watermark value into the program.
java.lang.String	getAlgHTML() Gives a description of what the algorithm does.
java.lang.String	getAlgURL() Specifies the URL of where the user can find more information about the algorithm.
ConfigProperties	getConfigProperties() Gets the ConfigProperties object which specifies the parameters for this run of the algorithm.
java.lang.String	getLongName() Returns this watermarker's long name.
static ConfigProperties	getProperties() Get the GENERAL properties of watermark
java.lang.String	getShortName() Returns this watermarker's short name.
java.util.Iterator	recognize(java.util.Properties props)
void	setConfigProperties(ConfigProperties props) Sets the ConfigProperties object which specifies the parameters for this run of the algorithm.
static void	setProperties(ConfigProperties props) Set the GENERAL properties of watermark

Methods inherited from class sandmark.watermark.StaticWatermarker

getAboutHTML, getHelpURL

Methods inherited from class sandmark.Algorithm

getAuthor, getAuthorEmail, getDescription, getMutations, getPostprohibited, getPostrequisites, getPostsuggestions, getPreprohibited, getPrerequisites, getPresuggestions, getReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configProps

static ConfigProperties configProps

Constructor Detail

ConstantString

public ConstantString()

Constructs a watermarker.

Method Detail

getShortName

public java.lang.String getShortName()

Returns this watermarker's short name.

Specified by:

getShortName in class Algorithm

Returns:

the short name for this algorithm

getLongName

public java.lang.String getLongName()

Returns this watermarker's long name.

Specified by:

getLongName in class Algorithm

Returns:

the long name for this algorithm

getProperties

public static ConfigProperties getProperties()

Description copied from class: GeneralWatermarker

Get the GENERAL properties of watermark

setProperties

public static void setProperties(ConfigProperties props)

Description copied from class: GeneralWatermarker

Set the GENERAL properties of watermark

getConfigProperties

public ConfigProperties getConfigProperties()

Description copied from class: Algorithm

Gets the ConfigProperties object which specifies the parameters for this run of the algorithm.

Specified by:

getConfigProperties in class Algorithm

Returns:

the parameters for this run of the algorithm

setConfigProperties

public void setConfigProperties(ConfigProperties props)

Description copied from class: Algorithm

Sets the ConfigProperties object which specifies the parameters for this run of the algorithm.

Specified by:

setConfigProperties in class Algorithm

Parameters:

props - the parameters for this run of the algorithm

getAlgHTML

public java.lang.String getAlgHTML()

Description copied from class: Algorithm

Gives a description of what the algorithm does. This should not be a long description of what your code does, rather a brief description as to what effect it has on the program. For example, a good algorithm description would be "Set Fields Public changes the scope of all static and non-static fields to public."; a bad algorithm description would be "Set Fields Public creates a BCEL object for each class and makes modifications to it, then stores it back into the jar file."

Specified by:

getAlgHTML in class Algorithm

Returns:

an HTML formatted description of what the algorithm does.

getAlgURL

public java.lang.String getAlgURL()

Description copied from class: Algorithm

Specifies the URL of where the user can find more information about the algorithm. This URL should point to the help.html file in the doc directory where the algorithm resides, starting from the sandmark directory. For example, the URL for the static_template watermarking sample would be sandmark/watermark/static_template/doc/help.html

Specified by:

getAlgURL in class Algorithm

Returns:

a URL to the help.html file for the algorithm

embed

public void embed(ClassFileCollection cfc,
                  java.util.jar.JarOutputStream output,
                  java.util.Properties props)
           throws WatermarkingException,
                  java.io.IOException

Description copied from class: StaticWatermarker

Embed a watermark value into the program. The props argument holds at least the following properties:

• WM_Encode_Watermark: The watermark value to be embedded.
• SWM_Embed_Key: The secret key.

Specified by:

embed in class StaticWatermarker

WatermarkingException

java.io.IOException

recognize

public java.util.Iterator recognize(java.util.Properties props)
                             throws WatermarkingException,
                                    java.io.IOException

Specified by:

recognize in class StaticWatermarker

WatermarkingException

java.io.IOException