edu.isi.policy.service
Interface PolicyService

All Known Implementing Classes:
PolicyServiceImpl

public interface PolicyService

Service that manages transfer advice based on VO-level policies

Author:
David Smith

Method Summary
 Cleanup addCleanup(Cleanup cleanup)
          Adds a new cleanup request to memory
 CleanupList addCleanups(CleanupList cleanups)
          Adds a list of cleanup requests to memory.
 Transfer addTransfer(Transfer transfer)
          Places a new transfer in the policy knowledge session
 TransferList addTransfers(TransferList transfers)
          Places new transfers in the policy knowledge session
 CleanupList getCleanups()
           
 PolicySession getPolicySession()
           
 java.util.List<Resource> getResources()
           
 Transfer getTransfer(java.lang.String transferId)
           
 TransferList getTransfers()
           
 void removeCleanup(java.lang.String id)
          Removes a cleanup from memory
 void removeTransfer(java.lang.String transferId)
          Removes a transfer from the knowledge session.
 void setPolicySession(PolicySession policySession)
          Sets the policy session
 Cleanup updateCleanup(java.lang.String cleanupId, Cleanup newCleanup)
          Updates an existing cleanup in the policy service
 CleanupList updateCleanups(CleanupList cleanups)
          Updates a list of cleanups in the policy service.
 Transfer updateTransfer(java.lang.String transferId, Transfer newTransfer)
          Updates the properties on a previously created transfer
 TransferList updateTransfers(TransferList transfers)
          Updates a list of transfers in the policy service.
 

Method Detail

addTransfers

TransferList addTransfers(TransferList transfers)
Places new transfers in the policy knowledge session

Parameters:
transfers - the new transfers to get advice from
Returns:
the transfers that the requester should invoke, including any necessary URL or properties changes

addTransfer

Transfer addTransfer(Transfer transfer)
Places a new transfer in the policy knowledge session

Parameters:
transfer - the transfer to add
Returns:
the updated transfer from the knowledge session, or nothing if the transfer was not placed in memory

removeTransfer

void removeTransfer(java.lang.String transferId)
Removes a transfer from the knowledge session.

Parameters:
transferId - the ID of the transfer to remove

getTransfers

TransferList getTransfers()
Returns:
the transfers that are currently known in the knowledge session.

getTransfer

Transfer getTransfer(java.lang.String transferId)
Parameters:
transferId - ID of an existing transfer
Returns:
the current version of the specified transfer

updateTransfer

Transfer updateTransfer(java.lang.String transferId,
                        Transfer newTransfer)
Updates the properties on a previously created transfer

Parameters:
transferId - the ID of the transfer to update.
Returns:
returns the new transfer object resulting from the policy rules running over the new properties

getPolicySession

PolicySession getPolicySession()
Returns:
a new or existing policy session

setPolicySession

void setPolicySession(PolicySession policySession)
Sets the policy session

Parameters:
policySession - the policy session

getResources

java.util.List<Resource> getResources()
Returns:
the list of known resources in memory

addCleanup

Cleanup addCleanup(Cleanup cleanup)
Adds a new cleanup request to memory

Parameters:
cleanup -

removeCleanup

void removeCleanup(java.lang.String id)
Removes a cleanup from memory

Parameters:
id - the ID of the cleanup

getCleanups

CleanupList getCleanups()
Returns:
a list of all cleanups in the system

addCleanups

CleanupList addCleanups(CleanupList cleanups)
Adds a list of cleanup requests to memory.

Parameters:
cleanups - the list of cleanups
Returns:
the resource cleanups that the client should invoke

updateCleanup

Cleanup updateCleanup(java.lang.String cleanupId,
                      Cleanup newCleanup)
Updates an existing cleanup in the policy service

Parameters:
cleanupId - ID of the cleanup
newCleanup - the new cleanup to update with
Returns:
the modified cleanup

updateTransfers

TransferList updateTransfers(TransferList transfers)
Updates a list of transfers in the policy service.

Parameters:
transfers - the transfers to update
Returns:
the updated transfers

updateCleanups

CleanupList updateCleanups(CleanupList cleanups)
Updates a list of cleanups in the policy service.

Parameters:
cleanups - the cleanups to update
Returns:
the updated cleanups


Copyright © 2012. All Rights Reserved.