Package edu.pdx.cs410J.grader

Class Submit

java.lang.Object

edu.pdx.cs410J.grader.EmailSender

edu.pdx.cs410J.grader.Submit

Direct Known Subclasses:

SubmitAndroidProject

public class Submit
extends EmailSender

This class is used to submit assignments in CS410J. The user specified his or her email address as well as the base directory for his/her source files on the command line. The directory is searched recursively for files that are allowed to be submitted. Those files are placed in a zip file and emailed to the grader. A confirmation email is sent to the submitter. More information about the JavaMail API can be found at: http://java.sun.com/products/javamail

Since:

Fall 2000 (Refactored to use fewer static methods in Spring 2006)

Author:

David Whitlock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	Submit.CurrentTimeProvider
(package private) static class	Submit.ManifestAttributes

Nested classes/interfaces inherited from class edu.pdx.cs410J.grader.EmailSender

EmailSender.NewEmail

Field Summary

Fields inherited from class edu.pdx.cs410J.grader.EmailSender

DAVE_EMAIL, serverName, TA_EMAIL

Constructor Summary

Constructors

Constructor	Description
Submit()	Creates a new Submit program
Submit(Submit.CurrentTimeProvider currentTimeProvider)

Method Summary

Modifier and Type	Method	Description
(package private) void	addFile(String fileName)	Adds the file with the given name to the list of files to be submitted.
protected boolean	canBeSubmitted(File file)
(package private) static boolean	canFileBeSubmitted(File file)
(package private) boolean	fileExists(File file)
protected String	getZipEntryNameFor(File file)	Returns the name of a File relative to the source directory.
(package private) static String	getZipEntryNameFor(String filePath)
(package private) String	getZipFileTitle()
(package private) boolean	isInMavenProjectDirectory(File file)
(package private) boolean	isNineDigitStudentId(String userId)
(package private) boolean	looksLikeAnEmailAddress(String userId)
static void	main(String[] args)
(package private) void	parseCommandLineAndSubmit(String[] args)	Parses the command line, finds the source files, prompts the user to verify whether or not the settings are correct, and then sends an email to the Grader.
void	setDebug(boolean debug)	Sets whether or not the progress of the submission should be logged.
(package private) void	setEmailServerHostName(String serverName)	Sets the name of the SMTP server that is used to send emails
void	setEstimatedHours(Double estimatedHours)
(package private) void	setProjectName(String projName)	Sets the name of project being submitted
(package private) void	setSendReceipt(boolean sendReceipt)
(package private) void	setStudent(Student student)
boolean	submit(boolean verify)	Submits the project to the grader
(package private) static boolean	submittedTestClasses(Set<File> sourceFiles)
protected void	usage(String message)	Prints usage information about this program.
(package private) void	validateProjectName()
protected void	warnIfMainProjectClassIsNotSubmitted(Set<File> sourceFiles)
protected void	warnIfTestClassesAreNotSubmitted(Set<File> sourceFiles)

Methods inherited from class edu.pdx.cs410J.grader.EmailSender

newEmailSession, newEmailTo, newInternetAddress, setEmailServerPort

Methods inherited from class java.lang.Object

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

Constructor Details

Submit

Submit()

Creates a new Submit program

Submit

Submit(Submit.CurrentTimeProvider currentTimeProvider)

Method Details

setEmailServerHostName

void setEmailServerHostName(String serverName)

Sets the name of the SMTP server that is used to send emails

setDebug

public void setDebug(boolean debug)

Sets whether or not the progress of the submission should be logged.

setProjectName

void setProjectName(String projName)

Sets the name of project being submitted

addFile

void addFile(String fileName)

Adds the file with the given name to the list of files to be submitted.

setStudent

void setStudent(Student student)

looksLikeAnEmailAddress

boolean looksLikeAnEmailAddress(String userId)

isNineDigitStudentId

boolean isNineDigitStudentId(String userId)

validateProjectName

void validateProjectName()

submit

public boolean submit(boolean verify)
               throws IOException,
jakarta.mail.MessagingException

Submits the project to the grader

Parameters:

verify - Should the user be prompted to verify his submission?

Returns:

Whether or not the submission actually occurred

Throws:

IllegalStateException - If no source files were found

IOException

jakarta.mail.MessagingException

canBeSubmitted

protected boolean canBeSubmitted(File file)

canFileBeSubmitted

static boolean canFileBeSubmitted(File file)

fileExists

boolean fileExists(File file)

isInMavenProjectDirectory

boolean isInMavenProjectDirectory(File file)

warnIfMainProjectClassIsNotSubmitted

protected void warnIfMainProjectClassIsNotSubmitted(Set<File> sourceFiles)

warnIfTestClassesAreNotSubmitted

protected void warnIfTestClassesAreNotSubmitted(Set<File> sourceFiles)

submittedTestClasses

static boolean submittedTestClasses(Set<File> sourceFiles)

getZipEntryNameFor

protected String getZipEntryNameFor(File file)

Returns the name of a File relative to the source directory.

getZipEntryNameFor

static String getZipEntryNameFor(String filePath)

getZipFileTitle

String getZipFileTitle()

usage

protected void usage(String message)

Prints usage information about this program.

main

public static void main(String[] args)
                 throws IOException,
jakarta.mail.MessagingException

Throws:

IOException

jakarta.mail.MessagingException

parseCommandLineAndSubmit

void parseCommandLineAndSubmit(String[] args)
                        throws IOException,
jakarta.mail.MessagingException

Parses the command line, finds the source files, prompts the user to verify whether or not the settings are correct, and then sends an email to the Grader.

Throws:

IOException

jakarta.mail.MessagingException

setSendReceipt

void setSendReceipt(boolean sendReceipt)

setEstimatedHours

public void setEstimatedHours(Double estimatedHours)