sandmark.watermark.ct
Class CT

java.lang.Object
  |
  +--sandmark.Algorithm
        |
        +--sandmark.watermark.GeneralWatermarker
              |
              +--sandmark.watermark.DynamicWatermarker
                    |
                    +--sandmark.watermark.ct.CT

public class CT

extends DynamicWatermarker

A StaticWatermarker object encapsulates code for running a particular static watermark algorithm.

Field Summary

(package private) Recognizer	recognizer
(package private) Tracer	tracer

Fields inherited from class sandmark.watermark.DynamicWatermarker

Constructor Summary

CT()
Constructs a watermarker with a given label.

Method Summary

void	embed(java.util.Properties props) Embed a watermark value into the program.
void	endTracing(java.util.Properties props, java.util.Vector tracePoints) This routine is called when the tracing run has completed. tracePoints is an array of trace points generated by sandmark.watermark.ct.trace.Tracer.
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.
java.lang.String	getShortName() Returns this watermarker's short name.
(package private) static java.util.Properties	preprocess()
void	setConfigProperties(ConfigProperties p) Sets the ConfigProperties object which specifies the parameters for this run of the algorithm.
void	startRecognition(java.util.Properties props) Start a recognition run of the program.
java.util.Iterator	startTracing(java.util.Properties props) Start a tracing run of the program.
void	stopRecognition(java.util.Properties props) Force the end to a tracing run of the program.
void	stopTracing(java.util.Properties props) Force an end to a tracing run of the program.
void	waitForTracingToComplete()
java.util.Iterator	watermarks() Return an iterator object that will generate the watermarks found in the program.

Methods inherited from class sandmark.watermark.DynamicWatermarker

getAboutHTML, getHelpURL, getProperties, setProperties

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

tracer

Tracer tracer

recognizer

Recognizer recognizer

Constructor Detail

CT

public CT()

Constructs a watermarker with a given label.

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

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 p)

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:

p - 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

preprocess

static java.util.Properties preprocess()

startTracing

public java.util.Iterator startTracing(java.util.Properties props)
                                throws TracingException

Start a tracing run of the program. Return an iterator object that will generate the trace points encountered by the program.

Specified by:

startTracing in class DynamicWatermarker

TracingException

waitForTracingToComplete

public void waitForTracingToComplete()
                              throws TracingException

Specified by:

waitForTracingToComplete in class DynamicWatermarker

TracingException

endTracing

public void endTracing(java.util.Properties props,
                       java.util.Vector tracePoints)
                throws TracingException

This routine is called when the tracing run has completed. tracePoints is an array of trace points generated by sandmark.watermark.ct.trace.Tracer. In our case, these are of type sandmark.watermark.ct.trace.TracePoint

Specified by:

endTracing in class DynamicWatermarker

TracingException

stopTracing

public void stopTracing(java.util.Properties props)
                 throws TracingException

Force an end to a tracing run of the program.

Specified by:

stopTracing in class DynamicWatermarker

TracingException

embed

public void embed(java.util.Properties props)

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.
• DWM_Embed_TraceInput: The name of the file containing trace data.
• WM_Embed_JarInput: The name of the file to be watermarked.
• WM_Embed_JarOutput: The name of the jar file to be constructed.
• DWM_ct_Encode_ClassName: The name of the Java file that builds the watermark.

Specified by:

embed in class DynamicWatermarker

startRecognition

public void startRecognition(java.util.Properties props)
                      throws TracingException

Start a recognition run of the program.

Specified by:

startRecognition in class DynamicWatermarker

TracingException

watermarks

public java.util.Iterator watermarks()

Return an iterator object that will generate the watermarks found in the program.

Specified by:

watermarks in class DynamicWatermarker

stopRecognition

public void stopRecognition(java.util.Properties props)
                     throws TracingException

Force the end to a tracing run of the program.

Specified by:

stopRecognition in class DynamicWatermarker

TracingException