A B C D E F G H I J L M N P Q R S T U V W Z

A

addBccRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

addCcRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

addEvent(PlanetsEvent) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Submit a Event to the NotificationManager.

addEvent(PlanetsEvent) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Submit a Event to the NotificationManager.

addEvent(DigitalObject, Event) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

addRecipient(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Address - Interface in eu.planets_project.ifr.core.security.api.model

This is the Address entity bean interface definition.

addRole(Role) - Method in interface eu.planets_project.ifr.core.security.api.model.User

addUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.SelfRegistrationManager

addUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Creates a new User, thowing an Exception if this fails:

appliedAsProvider() - Method in interface eu.planets_project.ifr.core.security.api.model.User

applyingAsProvider(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

assignRoleToUser(User, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Assign a role to a user.

B

basicMigrateBinary(byte[]) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsBasicService

ByteString - Class in eu.planets_project.services.utils

Utillity class for working with bytes, bytearrays, and strings.

C

checkAndUnzipTo(File, File, Checksum) - Static method in class eu.planets_project.services.utils.ZipUtils

Unzips a zip file and writes the content to destFolder, checking if the checksum is correct.

checkClientTrusted(X509Certificate[], String) - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

checkServerTrusted(X509Certificate[], String) - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

Checksums - Class in eu.planets_project.services.utils

Checksums util class.

Checksums() - Constructor for class eu.planets_project.services.utils.Checksums

cleanDigObUtilsTmp() - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

cleanOutdatedFiles() - Method in class eu.planets_project.services.utils.WebContentHelper

CliMigrationPath - Class in eu.planets_project.services.utils.cli

Migration paths created from a XML config file.

CliMigrationPath(Set<URI>, Set<URI>, String) - Constructor for class eu.planets_project.services.utils.cli.CliMigrationPath

CliMigrationPaths - Class in eu.planets_project.services.utils.cli

Create migration paths from an XML config file.

confirmPassword() - Method in interface eu.planets_project.ifr.core.security.api.model.User

CONTENT_PROPERTIES_PATH - Static variable in class eu.planets_project.services.utils.WebContentHelper

copyIntoHTMLDirectory(File) - Method in class eu.planets_project.services.utils.WebContentHelper

Copies a file into a public html directory and returns an http URL for it.

createSocket(Socket, String, int, boolean) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(InetAddress, int, InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(String, int, InetAddress, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket(String, int) - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createSocket() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

createTestService(QName, Class<T>, String) - Static method in class eu.planets_project.services.utils.test.ServiceCreator

This code handles the grotty details when instanciating a Planets service class for testing.

createTestService(QName, Class<T>, String, ServiceCreator.Mode) - Static method in class eu.planets_project.services.utils.test.ServiceCreator

This code handles the grotty details when instanciating a Planets service class for testing.

createZip(File, File, String, boolean) - Static method in class eu.planets_project.services.utils.ZipUtils

Creates a Zip64File zip file.

createZipAndCheck(File, File, String, boolean) - Static method in class eu.planets_project.services.utils.ZipUtils

Creates a Zip64File containing all the files in srcFolder and write it to destFolder using the passed zipName.

createZipTypeDigitalObject(File, String, boolean, boolean, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Creates a Zip-type DigitalObject either from a given folder or from a zip file.

D

debug(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

debug(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

deregisterSubscriber(EventSubscriber, int) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Terminates an active subscribtion.

deregisterSubscriber(EventSubscriber, int) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Terminates an active subscribtion.

digest(String, InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given InputStream.

digest(String, byte[]) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a byte array.

digest(String, String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given String.

digest(String, File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the checksum of a given File.

DigestException - Exception in eu.planets_project.services.utils

A RuntimeException thrown when there is unexpected errors computing a digest.

DigestException(String) - Constructor for exception eu.planets_project.services.utils.DigestException

DigestException(String, Throwable) - Constructor for exception eu.planets_project.services.utils.DigestException

DigitalObjectUtils - Class in eu.planets_project.services.utils

Utils for handling digital objects.

E

equals(Object) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Compare two Roles.

error(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

error(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

eu.planets_project.ifr.core.common.api - package eu.planets_project.ifr.core.common.api

General common API.

eu.planets_project.ifr.core.common.cli - package eu.planets_project.ifr.core.common.cli

Command line related common classes.

eu.planets_project.ifr.core.common.conf - package eu.planets_project.ifr.core.common.conf

eu.planets_project.ifr.core.common.impl - package eu.planets_project.ifr.core.common.impl

General common implementation classes.

eu.planets_project.ifr.core.common.mail - package eu.planets_project.ifr.core.common.mail

Mail-related common classes.

eu.planets_project.ifr.core.security.api.model - package eu.planets_project.ifr.core.security.api.model

Provides the data model for the security entities.

eu.planets_project.ifr.core.security.api.services - package eu.planets_project.ifr.core.security.api.services

Provides the Planets Security Service interfaces.

eu.planets_project.ifr.core.security.common - package eu.planets_project.ifr.core.security.common

Common classes of the security component.

eu.planets_project.services.utils - package eu.planets_project.services.utils

Helper classes for building Planets services.

eu.planets_project.services.utils.cli - package eu.planets_project.services.utils.cli

Utils for reading migration paths from an XML file.

eu.planets_project.services.utils.test - package eu.planets_project.services.utils.test

Helper classes for building unit tests for Planets services.

eu.planets_project.webui - package eu.planets_project.webui

UI-related Planets IF classes.

EventSubscriber - Interface in eu.planets_project.ifr.core.common.api

EventSubscriber interface Implement this interface to register and receive notifications.

F

fatal(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

fatal(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

FileAccess - Enum in eu.planets_project.services.utils.test

Access to test files.

findMigrationCommand(URI, URI) - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

findMigrationPath(URI, URI) - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

firstRole() - Method in interface eu.planets_project.ifr.core.security.api.model.User

firstRole(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

G

get(String) - Method in enum eu.planets_project.services.utils.test.FileAccess

getAcceptedIssuers() - Method in class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

getAccountEnabled() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAccountExpired() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAccountLocked() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAddress() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the first portion of the full address.

getAddress() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getAllFragments(File) - Static method in class eu.planets_project.services.utils.ZipUtils

A convenience method.

getAllRoles() - Method in interface eu.planets_project.ifr.core.security.api.services.RoleManager

Get a list of all of the roles

getAsPlanetsPaths() - Method in class eu.planets_project.services.utils.cli.CliMigrationPaths

getChecksum() - Method in class eu.planets_project.services.utils.ZipResult

getCity() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the city.

getClassPrefix() - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

getConmmandLine(List<Parameter>) - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getContentSize(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

getCountry() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the country.

getCredentialsExpired() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getDefault() - Static method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getDefaultCipherSuites() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getDescription() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the full description of the Role.

getDigitalObjectsAsFiles(List<DigitalObject>, File) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

A utility method that creates files for the content of "contained"-DigObs in a DigOb.

getEmail() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getEventBySummary(DigitalObject, String) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method returns event by summary in the targetObj

getFileFrom(File, String, File) - Static method in class eu.planets_project.services.utils.ZipUtils

Extracts a file specified by targetPathInZipfile from the passed zip and writes it to destFolder.

getFileNameFromDigObject(DigitalObject, URI) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Gets the title from the passed digOb and returns a proper file name

getFirstName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getFolderNameFromDigObject(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

Gets the title from the passed digOb and returns a proper folder name (e.g.

getFragment(DigitalObject, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method returns a new DigOb, containing a file that is specified by the fragment.

getFullName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getHost() - Method in class eu.planets_project.services.utils.WebContentHelper

getHostname() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The name of the server.

getId() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

getId() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

getId() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the ID, a unique primary key.

getId() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getIn() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getInstance() - Static method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Factory method for retrieving a NotificationManager instance.

getIsAdmin() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

Boolean getter for the nav bar to check whether the current user is in the admin role.

getLastName() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getLocation() - Method in enum eu.planets_project.services.utils.test.TestFile

getMessage() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

getMessage() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

getName() - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Get the Role name.

getOut() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getPassword() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPasswordHint() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPerformanceProperties() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

getPhoneNumber() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getPort() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The server port.

getPort() - Method in class eu.planets_project.services.utils.WebContentHelper

getPostalCode() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the post code.

getProcessError() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The OutputStream will either be the error-OutputStream directly from the execution of the native commands or a cache with the error-output of the execution of the native commands

getProcessError() - Method in class eu.planets_project.services.utils.ProcessRunner

The OutputStream will either be the error-OutputStream directly from the execution of the native commands or a cache with the error-output of the execution of the native commands.

getProcessErrorAsString() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Return what was printed on the error channel of a _finished_ process, as a string, including newlines

getProcessErrorAsString() - Method in class eu.planets_project.services.utils.ProcessRunner

Return what was printed on the error channel of a _finished_ process, as a string, including newlines.

getProcessOutput() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The OutputStream will either be the OutputStream directly from the execution of the native commands or a cache with the output of the execution of the native commands

getProcessOutput() - Method in class eu.planets_project.services.utils.ProcessRunner

The OutputStream will either be the OutputStream directly from the execution of the native commands or a cache with the output of the execution of the native commands.

getProcessOutputAsString() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Return what was printed on the output channel of a _finished_ process, as a string, including newlines

getProcessOutputAsString() - Method in class eu.planets_project.services.utils.ProcessRunner

Return what was printed on the output channel of a _finished_ process, as a string, including newlines.

getProvince() - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Get the name of the province.

getReturnCode() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Get the return code of the process.

getReturnCode() - Method in class eu.planets_project.services.utils.ProcessRunner

Get the return code of the process.

getRoleByName(String) - Method in interface eu.planets_project.ifr.core.security.api.services.RoleManager

getRoles() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getSharedFileBasePath() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

A helper method to look-up the file path the to shared resources, e.g.

getSharedFileContext() - Method in class eu.planets_project.webui.PlanetsSharedBackingBean

A helper to find the context that the shared resources are available from, e.g.

getSSLPort() - Static method in class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

The server secure sockets port.

getSupportedCipherSuites() - Method in class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

getTool() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

getTypes() - Method in enum eu.planets_project.services.utils.test.TestFile

getUser(Long) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets users information based on user id.

getUserByUsername(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets users information based on login name.

getUsername() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getUsernames() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets a list of all usernames.

getUsers() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Gets a list of all users.

getVersion() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getViewIdPrefix() - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

getWebAccessPath() - Method in class eu.planets_project.services.utils.WebContentHelper

getWebsite() - Method in interface eu.planets_project.ifr.core.security.api.model.User

getZipFile() - Method in class eu.planets_project.services.utils.ZipResult

grant(Principal) - Method in class eu.planets_project.ifr.core.security.common.JBossAuthorityGranter

H

hasEvent(DigitalObject, String) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

This method evaluates if particular digital object contains an ingest event

hashPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

This method takes the "natural" string password as entered by the user and hashes it for the database.

HOST - Static variable in class eu.planets_project.services.utils.WebContentHelper

I

info(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

info(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

initialiseFromFile(String) - Static method in class eu.planets_project.services.utils.cli.CliMigrationPaths

insertFileInto(File, File, String) - Static method in class eu.planets_project.services.utils.ZipUtils

Inserts a file into a given zip at a location specified by targetPath.

insertFragment(DigitalObject, File, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

invoke(Request, Response) - Method in class eu.planets_project.ifr.core.security.common.SingleSignOnPropagatorValve

invokeService(String) - Method in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

invokeService(String) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsService

isDebugEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isErrorEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isFatalEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isInfoEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isTimedOut() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Tells whether the process has timedout.

isTimedOut() - Method in class eu.planets_project.services.utils.ProcessRunner

Tells whether the process has timedout.

isTraceEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isUsernameAvailable(String) - Method in interface eu.planets_project.ifr.core.security.api.services.SelfRegistrationManager

Checks for username availability.

isUsernameAvailable(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Checks for username availability.

isWarnEnabled() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

isZipFile(File) - Static method in class eu.planets_project.services.utils.ZipUtils

isZipType(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

test if this is a zip type DigitalObject (format-URL == planets:fmt/ext/zip)

J

JBossAuthorityGranter - Class in eu.planets_project.ifr.core.security.common

JBossAuthorityGranter() - Constructor for class eu.planets_project.ifr.core.security.common.JBossAuthorityGranter

L

L2PlanetsService - Interface in eu.planets_project.ifr.core.common.api

This is a basic migration service, with no parameters or metadata.

LIFETIME - Static variable in class eu.planets_project.services.utils.WebContentHelper

listFragments(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

listRoles() - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Get a list of all the roles.

listUsersInRole(String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Helper to list all the users in a particular role.

listZipEntries(File) - Static method in class eu.planets_project.services.utils.ZipUtils

Lists all entries in this zip file.

loaded() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Allows developers to specify when the service has retrieved the data and loaded it into memory, ready for processing.

M

main(String[]) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

These cases:
- A compound DO, zip as Content, with MD outside the zip, pointing into it via Title.

md5(InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a given stream.

md5(String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a string.

md5(File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the MD5 checksum of a File.

N

NAME - Static variable in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

NotificationManager - Interface in eu.planets_project.ifr.core.common.api

NotificationManager interface Interface class for a generic NotificationManager.

NotificationManagerImpl - Class in eu.planets_project.ifr.core.common.impl

NotificationManagerImpl

P

PlanetsBasicService - Interface in eu.planets_project.ifr.core.common.api

Basic Planets Service Interface for level-1-services, only takes a byte[] and returns another one containing the migrated image.

PlanetsEvent - Interface in eu.planets_project.ifr.core.common.api

PlanetsEvent interface

PlanetsEventExample - Class in eu.planets_project.ifr.core.common.impl

Example implementation of PlanetsEvent interface.

PlanetsEventExample() - Constructor for class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

Empty constructor.

PlanetsEventExample(int, String) - Constructor for class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

Create a PlanetsEvent with given id and message.

PlanetsException - Exception in eu.planets_project.ifr.core.common.api

PlanetsException(String) - Constructor for exception eu.planets_project.ifr.core.common.api.PlanetsException

PlanetsException(Throwable) - Constructor for exception eu.planets_project.ifr.core.common.api.PlanetsException

PlanetsFaceletsResourceResolver - Class in eu.planets_project.webui

Allows templates to be shared, as using this resolver will patch the resources from this package to a specific local URI /planets-webui-shared/* Add this to your web.xml to use the Planets resource resolver from Facelets.

PlanetsFaceletsResourceResolver() - Constructor for class eu.planets_project.webui.PlanetsFaceletsResourceResolver

PlanetsLogger - Interface in eu.planets_project.ifr.core.common.api

PlanetsLogger Interface

PlanetsMailer - Class in eu.planets_project.ifr.core.common.mail

PlanetsMailer() - Constructor for class eu.planets_project.ifr.core.common.mail.PlanetsMailer

PlanetsMailMessage - Class in eu.planets_project.ifr.core.common.mail

A Planets mail message.

PlanetsMailMessage() - Constructor for class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Creates a Planets mail message.

PlanetsServerConfig - Class in eu.planets_project.ifr.core.common.conf

Planets server configuration.

PlanetsServerConfig() - Constructor for class eu.planets_project.ifr.core.common.conf.PlanetsServerConfig

PlanetsService - Interface in eu.planets_project.ifr.core.common.api

Planets Service Interface

PlanetsSharedBackingBean - Class in eu.planets_project.webui

Utility backing bean for Planets web components.

PlanetsSharedBackingBean() - Constructor for class eu.planets_project.webui.PlanetsSharedBackingBean

PORT - Static variable in class eu.planets_project.services.utils.WebContentHelper

ProcessRunner - Class in eu.planets_project.ifr.core.common.cli

Native command executor.

ProcessRunner() - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner.

ProcessRunner(String) - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner with just this command, with no arguments.

ProcessRunner(List<String>) - Constructor for class eu.planets_project.ifr.core.common.cli.ProcessRunner

Create a new ProcessRunner with the given command.

ProcessRunner - Class in eu.planets_project.services.utils

Native command executor.

ProcessRunner() - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner.

ProcessRunner(String) - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner with just this command, with no arguments.

ProcessRunner(List<String>) - Constructor for class eu.planets_project.services.utils.ProcessRunner

Create a new ProcessRunner with the given command.

Q

QNAME - Static variable in interface eu.planets_project.ifr.core.common.api.L2PlanetsService

R

registerSubscriber(EventSubscriber, int) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Register for a specific event type classified by numeric identifier.

registerSubscriber(EventSubscriber, int) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Register for a specific event type classified by numeric identifier.

removeFileFrom(File, String) - Static method in class eu.planets_project.services.utils.ZipUtils

Removes the file 'fileToRemove' from zipFile.

removeFragment(DigitalObject, String, boolean) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

removeRole(Role) - Method in interface eu.planets_project.ifr.core.security.api.model.User

removeUser(Long) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Removes a user from the database by id.

resolveUrl(String) - Method in class eu.planets_project.webui.PlanetsFaceletsResourceResolver

Resource - Interface in eu.planets_project.ifr.core.security.api.model

An interface to wrap a generic resource.

revokeRoleFromUser(User, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Un-assign a role from a user.

Role - Interface in eu.planets_project.ifr.core.security.api.model

This is the Role entity bean definition.

RoleManager - Interface in eu.planets_project.ifr.core.security.api.services

RoleManager.RoleNotFoundException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a role name cannot be found.

RoleManager.RoleNotFoundException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.RoleManager.RoleNotFoundException

rolesAsStrings() - Method in interface eu.planets_project.ifr.core.security.api.model.User

run() - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Run the method, feeding it input, and killing it if the timeout is exceeded.

run() - Method in class eu.planets_project.services.utils.ProcessRunner

Run the method, feeding it input, and killing it if the timeout is exceeded.

S

saveUser(User) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

Saves a user's information.

SelfRegistrationManager - Interface in eu.planets_project.ifr.core.security.api.services

send(PlanetsMailMessage) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailer

Send a simple message with pre-populated values.

send() - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

Sends the message

sendMessage(PlanetsMailMessage, String, Map) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailer

Send a simple message based on a Velocity template.

sendUserMessage(String, String, String) - Method in interface eu.planets_project.ifr.core.security.api.services.UserManager

This is a simple wrapper that makes is simple to send a message to a user.

ServiceCreator - Class in eu.planets_project.services.utils.test

Service creation utilities for use when using testing.

ServiceCreator.Mode - Enum in eu.planets_project.services.utils.test

Modes for creating a service implementation instance.

ServicePerformanceHelper - Class in eu.planets_project.services.utils

A standardised timing and performance data collection class, used to monitor performance consistently across services.

ServicePerformanceHelper() - Constructor for class eu.planets_project.services.utils.ServicePerformanceHelper

setAccountEnabled(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAccountExpired(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAccountLocked(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setAddress(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the first line of the address.

setAddress(Address) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setBccRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setBody(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setCcRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setChecksum(Checksum) - Method in class eu.planets_project.services.utils.ZipResult

setChecksum(String, byte[]) - Method in class eu.planets_project.services.utils.ZipResult

setCity(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the city.

setCollection(boolean) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Decide if the outputstreams should be collected.

setCollection(boolean) - Method in class eu.planets_project.services.utils.ProcessRunner

Decide if the outputstreams should be collected.

setCommand(List<String>) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the command for this ProcessRunner

setCommand(List<String>) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the command for this ProcessRunner.

setConfirmPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setCountry(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the country.

setCredentialsExpired(boolean) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setDescription(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set the description for this role.

setEmail(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setEnviroment(Map<String, String>) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Sets the enviroment that the process should run in.

setEnviroment(Map<String, String>) - Method in class eu.planets_project.services.utils.ProcessRunner

Sets the enviroment that the process should run in.

setErrorCollectionByteSize(int) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

How many bytes should we collect from the ErrorStream.

setErrorCollectionByteSize(int) - Method in class eu.planets_project.services.utils.ProcessRunner

How many bytes should we collect from the ErrorStream.

setFirstName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setId(Long) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set the ID for this role, usually done automatically.

setId(Long) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setInputStream(InputStream) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the inputstream, from which the process should read.

setInputStream(InputStream) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the inputstream, from which the process should read.

setLastName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setName(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Role

Set this name for this role.

setOutputCollectionByteSize(int) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

How many bytes should we collect from the OutputStream.

setOutputCollectionByteSize(int) - Method in class eu.planets_project.services.utils.ProcessRunner

How many bytes should we collect from the OutputStream.

setPassword(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPasswordHint(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPhoneNumber(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setPostalCode(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the post code.

setProvince(String) - Method in interface eu.planets_project.ifr.core.security.api.model.Address

Set the Province.

setRecipients(List<InternetAddress>) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setRoles(Set<Role>) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setSender(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setStartingDir(File) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

The directory to be used as starting dir.

setStartingDir(File) - Method in class eu.planets_project.services.utils.ProcessRunner

The directory to be used as starting dir.

setSubject(String) - Method in class eu.planets_project.ifr.core.common.mail.PlanetsMailMessage

setSubscriberActive(EventSubscriber, boolean) - Method in interface eu.planets_project.ifr.core.common.api.NotificationManager

Sets the current status of an subscriber active/inactive.

setSubscriberActive(EventSubscriber, boolean) - Method in class eu.planets_project.ifr.core.common.impl.NotificationManagerImpl

Sets the current status of an subscriber active/inactive.

setTimeout(long) - Method in class eu.planets_project.ifr.core.common.cli.ProcessRunner

Set the timeout.

setTimeout(long) - Method in class eu.planets_project.services.utils.ProcessRunner

Set the timeout.

setUsername(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setVersion(Integer) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setWebsite(String) - Method in interface eu.planets_project.ifr.core.security.api.model.User

setZipFile(File) - Method in class eu.planets_project.services.utils.ZipResult

sha1(InputStream) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a given stream.

sha1(String) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a string.

sha1(File) - Static method in class eu.planets_project.services.utils.Checksums

Calculate the SHA-1 checksum of a File.

SingleSignOnPropagatorValve - Class in eu.planets_project.ifr.core.security.common

SingleSignOnPropagatorValve() - Constructor for class eu.planets_project.ifr.core.security.common.SingleSignOnPropagatorValve

stop() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Stop all timers, as all work has been done apart from returning from the service call method.

T

TEMP_DIR - Static variable in class eu.planets_project.services.utils.WebContentHelper

TestFile - Enum in eu.planets_project.services.utils.test

Enum containing files to test i.e.

testIdentification(TestFile, Identify) - Static method in enum eu.planets_project.services.utils.test.TestFile

testIdentification(Identify) - Static method in enum eu.planets_project.services.utils.test.TestFile

testValidation(TestFile, Validate) - Static method in enum eu.planets_project.services.utils.test.TestFile

testValidation(Validate) - Static method in enum eu.planets_project.services.utils.test.TestFile

toFile(DigitalObject) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

toFile(DigitalObject, File) - Static method in class eu.planets_project.services.utils.DigitalObjectUtils

toHex(byte[]) - Static method in class eu.planets_project.services.utils.ByteString

Converts a byte array to a hexstring.

toString() - Method in interface eu.planets_project.ifr.core.common.api.PlanetsEvent

toString() - Method in class eu.planets_project.ifr.core.common.impl.PlanetsEventExample

trace(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

trace(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

transferred() - Method in class eu.planets_project.services.utils.ServicePerformanceHelper

Allows developers to specify when the service has finished retrieving data, and is now only going to process the inputs and compose the response.

TrustingSSLSocketFactory - Class in eu.planets_project.ifr.core.common.mail

This is a 'Trusting' SSL socket factory that does not check the host certificate.

TrustingSSLSocketFactory() - Constructor for class eu.planets_project.ifr.core.common.mail.TrustingSSLSocketFactory

TrustingTrustManager - Class in eu.planets_project.ifr.core.common.mail

These should throw CertificateExceptions if certs can't be traced.

TrustingTrustManager() - Constructor for class eu.planets_project.ifr.core.common.mail.TrustingTrustManager

U

unzipTo(File, File) - Static method in class eu.planets_project.services.utils.ZipUtils

Unzips a zip file and writes the contained files to destFolder.

update(PlanetsEvent) - Method in interface eu.planets_project.ifr.core.common.api.EventSubscriber

User - Interface in eu.planets_project.ifr.core.security.api.model

This is the User entity bean definition.

UserManager - Interface in eu.planets_project.ifr.core.security.api.services

The Planets User Manager

UserManager.UserNotFoundException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a username cannot be found.

UserManager.UserNotFoundException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.UserManager.UserNotFoundException

UserManager.UserNotValidException - Exception in eu.planets_project.ifr.core.security.api.services

Exception thrown when a user cannot be stored as it is not valid.

UserManager.UserNotValidException() - Constructor for exception eu.planets_project.ifr.core.security.api.services.UserManager.UserNotValidException

useTempDestinationFile() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

useTempSourceFile() - Method in class eu.planets_project.services.utils.cli.CliMigrationPath

V

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.FileAccess

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.ServiceCreator.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.planets_project.services.utils.test.TestFile

Returns the enum constant of this type with the specified name.

values() - Static method in enum eu.planets_project.services.utils.test.FileAccess

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.utils.test.ServiceCreator.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.planets_project.services.utils.test.TestFile

Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(Object) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

warn(Object, Throwable) - Method in interface eu.planets_project.ifr.core.common.api.PlanetsLogger

WEB_ACCESS_PATH - Static variable in class eu.planets_project.services.utils.WebContentHelper

WebContentHelper - Class in eu.planets_project.services.utils

Utility class to provide content via a web server Requires external access to a web server.

WebContentHelper() - Constructor for class eu.planets_project.services.utils.WebContentHelper

Z

ZipResult - Class in eu.planets_project.services.utils

ZipResult(File, Checksum) - Constructor for class eu.planets_project.services.utils.ZipResult

ZipResult() - Constructor for class eu.planets_project.services.utils.ZipResult

Create an empty result.

ZipUtils - Class in eu.planets_project.services.utils

ZipUtils() - Constructor for class eu.planets_project.services.utils.ZipUtils

A B C D E F G H I J L M N P Q R S T U V W Z