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 TypeMethodDescriptionvoid
alreadyRegistered
(String ownerId, String targetFilename) Called if thetargetFilename
for the specifiedownerId
has already been registered.void
Called if the registration of thetargetFilename
for the specifiedownerId
has been refused since the path already belongs to theactualOwnerId
.void
registered
(String ownerId, String targetFilename) Called if thetargetFilename
for the specifiedownerId
has been registered successfully.void
superseded
(String ownerId, String targetFilename, String deprecatedOwnerId) Called if thetargetFilename
for the specifiedownerId
has been registered successfully by superseding adeprecatedOwnerId
, that is the previous owner of the file.void
supersededUnknownOwner
(String ownerId, String targetFilename, String unknownOwnerId) Called if thetargetFilename
for the specifiedownerId
has been registered successfully by superseding aunknownOwnerId
, that is an owner that does not exist anymore in the current project.
-
Method Details
-
registered
Called if thetargetFilename
for the specifiedownerId
has been registered successfully. This means that thetargetFilename
was unknown and has been registered successfully.- Parameters:
ownerId
- the ownerIdtargetFilename
- the relative path according to the root of the webapp- Throws:
IOException
- if an error occurred while handling this event
-
alreadyRegistered
Called if thetargetFilename
for the specifiedownerId
has already been registered. This means that thetargetFilename
was known and belongs to the specified owner.- Parameters:
ownerId
- the ownerIdtargetFilename
- the relative path according to the root of the webapp- Throws:
IOException
- if an error occurred while handling this event
-
refused
Called if the registration of the
This means that thetargetFilename
for the specifiedownerId
has been refused since the path already belongs to theactualOwnerId
.targetFilename
was known and does not belong to the specified owner.- Parameters:
ownerId
- the ownerIdtargetFilename
- the relative path according to the root of the webappactualOwnerId
- the actual owner- Throws:
IOException
- if an error occurred while handling this event
-
superseded
Called if thetargetFilename
for the specifiedownerId
has been registered successfully by superseding adeprecatedOwnerId
, that is the previous owner of the file. This means that thetargetFilename
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 ownerIdtargetFilename
- the relative path according to the root of the webappdeprecatedOwnerId
- 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 thetargetFilename
for the specifiedownerId
has been registered successfully by superseding aunknownOwnerId
, that is an owner that does not exist anymore in the current project. This means that thetargetFilename
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 ownerIdtargetFilename
- the relative path according to the root of the webappunknownOwnerId
- the previous owner that does not exist anymore- Throws:
IOException
- if an error occurred while handling this event
-