org.apache.maven.plugins.war.util

Interface WebappStructure.RegistrationCallback

Enclosing class:

WebappStructure

public static interface WebappStructure.RegistrationCallback

Callback interface to handle events related to filepath registration in the webapp.

Method Summary

Modifier and Type	Method and Description
void	alreadyRegistered(String ownerId, String targetFilename) Called if the targetFilename for the specified ownerId has already been registered.
void	refused(String ownerId, String targetFilename, String actualOwnerId) Called if the registration of the targetFilename for the specified ownerId has been refused since the path already belongs to the actualOwnerId.
void	registered(String ownerId, String targetFilename) Called if the targetFilename for the specified ownerId has been registered successfully.
void	superseded(String ownerId, String targetFilename, String deprecatedOwnerId) Called if the targetFilename for the specified ownerId has been registered successfully by superseding a deprecatedOwnerId, that is the previous owner of the file.
void	supersededUnknownOwner(String ownerId, String targetFilename, String unknownOwnerId) Called if the targetFilename for the specified ownerId has been registered successfully by superseding a unknownOwnerId, that is an owner that does not exist anymore in the current project.

Method Detail

registered

void registered(String ownerId,
                String targetFilename)
         throws IOException

Called if the targetFilename for the specified ownerId has been registered successfully. This means that the targetFilename was unknown and has been registered successfully.

Parameters:

ownerId - the ownerId

targetFilename - the relative path according to the root of the webapp

Throws:

IOException - if an error occurred while handling this event

alreadyRegistered

void alreadyRegistered(String ownerId,
                       String targetFilename)
                throws IOException

Called if the targetFilename for the specified ownerId has already been registered. This means that the targetFilename was known and belongs to the specified owner.

Parameters:

ownerId - the ownerId

targetFilename - the relative path according to the root of the webapp

Throws:

IOException - if an error occurred while handling this event

refused

void refused(String ownerId,
             String targetFilename,
             String actualOwnerId)
      throws IOException

Called if the registration of the targetFilename for the specified ownerId has been refused since the path already belongs to the actualOwnerId.

This means that the targetFilename was known and does not belong to the specified owner.

Parameters:

ownerId - the ownerId

targetFilename - the relative path according to the root of the webapp

actualOwnerId - the actual owner

Throws:

IOException - if an error occurred while handling this event

superseded

void superseded(String ownerId,
                String targetFilename,
                String deprecatedOwnerId)
         throws IOException

Called if the targetFilename for the specified ownerId has been registered successfully by superseding a deprecatedOwnerId, that is the previous owner of the file. This means that the targetFilename was known but for another owner. This usually happens after a project's configuration change. As a result, the file has been registered successfully to the new owner.

Parameters:

ownerId - the ownerId

targetFilename - the relative path according to the root of the webapp

deprecatedOwnerId - the previous owner that does not exist anymore

Throws:

IOException - if an error occurred while handling this event

supersededUnknownOwner

void supersededUnknownOwner(String ownerId,
                            String targetFilename,
                            String unknownOwnerId)
                     throws IOException

Called if the targetFilename for the specified ownerId has been registered successfully by superseding a unknownOwnerId, that is an owner that does not exist anymore in the current project. This means that the targetFilename was known but for an owner that does not exist anymore. Hence the file has been registered successfully to the new owner.

Parameters:

ownerId - the ownerId

targetFilename - the relative path according to the root of the webapp

unknownOwnerId - the previous owner that does not exist anymore

Throws:

IOException - if an error occurred while handling this event