com.globalmentor.application

Interface Application

All Superinterfaces:

com.globalmentor.model.Named<String>, com.globalmentor.net.Resource

All Known Implementing Classes:

AbstractApplication

public interface Application
extends com.globalmentor.net.Resource, com.globalmentor.model.Named<String>

An application that by default is a console application.

Every application provides a default preference node based upon the implementing application class.

Author:

Garret Wilson

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	NO_ARGUMENTS An array containing no arguments.

Fields inherited from interface com.globalmentor.net.Resource

URI_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
boolean	canStart() Checks requirements, permissions, and expirations before starting.
void	displayError(String message) Displays the given error to the user
void	displayError(Throwable throwable) Displays an error message to the user for an exception.
void	exit() Exits the application with no status.
void	exit(int status) Exits the application with the given status.
String[]	getArgs()
com.globalmentor.net.Authenticable	getAuthenticator()
Date	getExpirationDate()
Preferences	getPreferences()
void	initialize() Initializes the application.
int	main() The main application method.
void	setAuthenticator(com.globalmentor.net.Authenticable authenticable) Sets the authenticator object used to retrieve client authentication.

Methods inherited from interface com.globalmentor.net.Resource

getURI

Methods inherited from interface com.globalmentor.model.Named

getName

Field Detail

NO_ARGUMENTS

static final String[] NO_ARGUMENTS

An array containing no arguments.

Method Detail

getAuthenticator

com.globalmentor.net.Authenticable getAuthenticator()

Returns:

The authenticator object used to retrieve client authentication.

setAuthenticator

void setAuthenticator(com.globalmentor.net.Authenticable authenticable)

Sets the authenticator object used to retrieve client authentication.

Parameters:

authenticable - The object to retrieve authentication information regarding a client.

See Also:

HTTPClient

getArgs

String[] getArgs()

Returns:

The command-line arguments of the application.

getPreferences

Preferences getPreferences()
                    throws SecurityException

Returns:

The default user preferences for this application.

Throws:

SecurityException - Thrown if a security manager is present and it denies RuntimePermission("preferences").

getExpirationDate

Date getExpirationDate()

Returns:

The expiration date of the application, or null if there is no expiration.

initialize

void initialize()
         throws Exception

Initializes the application. This method is called after construction but before application execution.

Throws:

Exception - Thrown if anything goes wrong.

main

int main()

The main application method.

Returns:

The application status.

canStart

boolean canStart()

Checks requirements, permissions, and expirations before starting.

Returns:

true if the checks succeeded.

displayError

void displayError(Throwable throwable)

Displays an error message to the user for an exception.

Parameters:

throwable - The condition that caused the error.

displayError

void displayError(String message)

Displays the given error to the user

Parameters:

message - The error to display.

exit

void exit()

Exits the application with no status. Convenience method which calls exit(int).

See Also:

exit(int)

exit

void exit(int status)

Exits the application with the given status. This method first checks to see if exit can occur.

Parameters:

status - The exit status.

See Also:

#canExit(), #performExit(int)