it.zielke.moji

Class SocketClient

java.lang.Object

it.zielke.moji.SocketClient

public class SocketClient
extends Object

Client for communicating with the MOSS server socket. Handles the configuration, sending of files and receiving results.

Constructor Summary

Constructors

Constructor and Description
SocketClient() Construct socket client with default host, port and programming language of the source files to be uploaded.
SocketClient(String server, int port) Construct socket client by setting a server and port.
SocketClient(String server, int port, String language) Construct socket client by setting a server name and port as well as the programming language of the source files.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close connection to the MOSS server gracefully.
void	connect() Connect to the MOSS server and set the input and output streams for communication.
Stage	getCurrentStage()
int	getIncSetID() Deprecated.
String	getLanguage()
String	getOptC()
int	getOptD()
long	getOptM()
long	getOptN()
int	getOptX()
int	getPort()
URL	getResultURL()
String	getServer()
int	getSetID()
Socket	getSocket()
List<String>	getSupportedLanguages()
String	getUserID()
String	normalizeFilename(String filename)
String	readFromServer() Read a single line of the server's response.
void	run() Shortcut method to connect to the MOSS server, send all initialization parameters and set the programming language of all source files.
void	sendInitialization() Sends initialization commands to the server.
void	sendLanguage() Sends a command to the server to define the programming language of all source files.
void	sendLanguage(String language) Sends a command to the server to define the programming language of all source files.
void	sendQuery() Sends a command to tell the server that all files have been uploaded and the search for plagiarism can start.
void	setLanguage(String language) Set the programming language of all source files.
void	setOptC(String optC) Sets a comment string which is attached to the MOSS report.
void	setOptM(long optM) Set the maximum amount of times a source code passage may appear before it is ignored and treated as base code.
void	setOptN(long optN) Sets how many matches should be displayed in the MOSS results.
void	setOptX(int optX) Setting this value to 1 enables the experimental MOSS server.
void	setPort(int port)
void	setServer(String server)
void	setSocket(Socket socket)
void	setUserID(String userID) Set the MOSS user id for authentication with the MOSS server.
void	uploadBaseFile(File file) Uploads a single base file to the MOSS server.
void	uploadFile(File file) Uploads a single file to the MOSS server.
void	uploadFile(File file, boolean isBaseFile) Uploads a single file to the MOSS server.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketClient

public SocketClient()

Construct socket client with default host, port and programming language of the source files to be uploaded. Default language is Java.

SocketClient

public SocketClient(String server,
            int port)

Construct socket client by setting a server and port.

Parameters:

server - host name or IP of the MOSS server

port - port of the MOSS server

SocketClient

public SocketClient(String server,
            int port,
            String language)

Construct socket client by setting a server name and port as well as the programming language of the source files.

Parameters:

server - host name or IP of the MOSS server

port - port of the MOSS server

language - programming language of all source files

Method Detail

close

public void close()

Close connection to the MOSS server gracefully.

connect

public void connect()
             throws UnknownHostException,
                    IOException,
                    SecurityException

Connect to the MOSS server and set the input and output streams for communication.

Throws:

UnknownHostException - if host resolution fails

IOException - if setting up the input streams fails

SecurityException - if a connection is disallowed by your security manager

getCurrentStage

public Stage getCurrentStage()

Returns:

the current internal stage of the client.

getIncSetID

@Deprecated
public int getIncSetID()

Deprecated.

Increment the set ID internally. Do not increment this manually unless you have a good reason. Might be removed in the future.

Returns:

the last set ID, before this increment.

getLanguage

public String getLanguage()

getOptC

public String getOptC()

getOptD

public int getOptD()

getOptM

public long getOptM()

getOptN

public long getOptN()

getOptX

public int getOptX()

getPort

public int getPort()

getResultURL

public URL getResultURL()

Returns:

the URL which points to the plagiarism report, located on the MOSS web server.

getServer

public String getServer()

getSetID

public int getSetID()

getSocket

public Socket getSocket()

getSupportedLanguages

public List<String> getSupportedLanguages()

Returns:

a list of supported programming languages by the MOSS server.

getUserID

public String getUserID()

readFromServer

public String readFromServer()
                      throws IOException

Read a single line of the server's response.

Returns:

the line read

Throws:

IOException - if it was not possible to read from the socket

run

public void run()
         throws MossException,
                IOException,
                UnknownHostException

Shortcut method to connect to the MOSS server, send all initialization parameters and set the programming language of all source files. Call this before uploading any files.

Throws:

MossException - if the MOSS server returns an error

IOException - if there is a (network) error while reading the server response

UnknownHostException - if host resolution fails

sendInitialization

public void sendInitialization()
                        throws MossException

Sends initialization commands to the server. Needs to be called after connecting to the server but before sending any files.

Throws:

MossException

sendLanguage

public void sendLanguage()
                  throws MossException,
                         IOException

Sends a command to the server to define the programming language of all source files. The language must be set beforehand using setLanguage().

Throws:

MossException - if this language is not supported by the MOSS server

IOException - if there is an error while reading the server answer

See Also:

setLanguage(String)

sendLanguage

public void sendLanguage(String language)
                  throws MossException,
                         IOException

Sends a command to the server to define the programming language of all source files.

Parameters:

language - the programming language of all source files

Throws:

MossException - if this language is not supported by the MOSS server

IOException - if there is an error while reading the server answer

sendQuery

public void sendQuery()
               throws MossException,
                      IOException

Sends a command to tell the server that all files have been uploaded and the search for plagiarism can start. Waits for an answer from the server which may take some minutes.

Throws:

MossException - if there is an error when receiving results from the MOSS server

IOException - if the server communication fails

setLanguage

public void setLanguage(String language)
                 throws MossException

Set the programming language of all source files.

Parameters:

language - the programming language in which source file is written in. Valid programming languages are: c, cc, java, ml, pascal, ada, lisp, schema, haskell, fortran, ascii, vhdl, perl, matlab, python, mips, prolog, spice, vb, csharp, modula2, a8086, javascript and plsql.

Throws:

MossException

setOptC

public void setOptC(String optC)

Sets a comment string which is attached to the MOSS report. Individual reports can then easily be distinguished.

Parameters:

optC - comment string

setOptM

public void setOptM(long optM)

Set the maximum amount of times a source code passage may appear before it is ignored and treated as base code. This is a good way to detect base/template code usage within students' solutions while uploading base code is unsupported by this client. Corresponds to the -m parameter of the original client.

Parameters:

optM - times a passage may appear before it is ignored

setOptN

public void setOptN(long optN)

Sets how many matches should be displayed in the MOSS results. Default is 250.

Parameters:

optN - how many matches to display

setOptX

public void setOptX(int optX)

Setting this value to 1 enables the experimental MOSS server. This is pretty much untested. Default is 0.

Parameters:

optX - 0 or 1. 0: regular MOSS server, 1: experimental MOSS server.

setPort

public void setPort(int port)

setServer

public void setServer(String server)

setSocket

public void setSocket(Socket socket)

setUserID

public void setUserID(String userID)

Set the MOSS user id for authentication with the MOSS server.

Parameters:

userID - your personalized ID to authenticate with. It should look like /[0-9]+/ and is available on the MOSS page located at http://theory.stanford.edu/~aiken/moss/

uploadFile

public void uploadFile(File file)
                throws IOException

Uploads a single file to the MOSS server.

Parameters:

file - the source code file to be uploaded

Throws:

IOException - if the file could not be read

uploadBaseFile

public void uploadBaseFile(File file)
                    throws IOException

Uploads a single base file to the MOSS server.

Parameters:

file - the base file to be uploaded

Throws:

IOException - if the file could not be read

uploadFile

public void uploadFile(File file,
              boolean isBaseFile)
                throws IOException

Uploads a single file to the MOSS server.

Parameters:

file - the source code file to be uploaded

isBaseFile - true is base file. false otherwise.

Throws:

IOException - if the file could not be read

normalizeFilename

public String normalizeFilename(String filename)