uk.ac.soton.itinnovation.grid.comms.sla
Interface SLAResource

All Superinterfaces:

IdentifiableResource, PolicyManagement, ResourceMetadata, Signallable, WSResourceLifetime, WSTrust

All Known Subinterfaces:

SLAConversation, SLAServiceSOAP

All Known Implementing Classes:

SLAServiceImpl

@WebService(targetNamespace="http://www.it-innovation.soton.ac.uk/2004/grid/sla",
            name="SLAService",
            serviceName="SLAService")
public interface SLAResource
extends PolicyManagement, ResourceMetadata, WSTrust, IdentifiableResource, Signallable, WSResourceLifetime

Public operations on SLA resources. This interface lists the contextualised operations on SLAs, implemented by both the service and by the client proxy.

Field Summary

static String

SLA_RESOURCE_TYPE Resource type for SLA resources.

Fields inherited from interface uk.ac.soton.itinnovation.grid.comms.wstrust.WSTrust

DEFAULT_WSTRUST_ISSUER, requestSecurityToken, VALIDATE_SUBJECT_DESCRIPTION, WSTRUST_REQUEST_TYPE_ISSUANCE, WSTRUST_REQUEST_TYPE_VALIDATION, WSTRUST_SAML_1_1, WSTRUST_STATUS, WSTRUST_STATUS_INVALID, WSTRUST_STATUS_VALID, XMLNS_WSTRUST, XMLNS_WSU

Method Summary

void	addOwnerRule(MatchRule rule) Deprecated.
void	addUserRule(MatchRule rule) Deprecated.
boolean	checkUser(SubjectDescription user) Test whether this user has the 'user' role.
void	closeSLA() Close an SLA
void	continueActivity(org.apache.axis.message.addressing.EndpointReferenceType activityEPR, Constraint[] constraints) Checks that a change in an activity should be permitted.
MatchRule[]	getOwnerRules() Deprecated.
String	getSLAState() Deprecated.
SLATemplate	getSLATerms() Gets the Terms for an SLA
SLAUsageSummary	getUsage(Date start, Date end, long reportInterval, long maxReports) Gets usage reports from an sla
Document	getUsageSummary() Deprecated. see getUsage(java.util.Date, java.util.Date, long, long)
MatchRule[]	getUserRules() Deprecated.
void	removeOwnerRule(MatchRule rule) Deprecated.
void	removeUserRule(MatchRule rule) Deprecated.
void	startActivity(org.apache.axis.message.addressing.EndpointReferenceType activityEPR, Constraint[] constraints, UsageReport[] reports) Check that an activity should be started.

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.PolicyManagement

addPolicyRule, getPolicyRules, getValidRoles, removePolicyRule

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.ResourceMetadata

getEPR, setLabel

Methods inherited from interface uk.ac.soton.itinnovation.grid.comms.wstrust.WSTrust

RequestSecurityToken

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.IdentifiableResource

getServiceMatchPattern

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.Signallable

getAvailableSignals, signal

Methods inherited from interface uk.ac.soton.itinnovation.grid.comms.wsrf.WSResourceLifetime

destroy

Field Detail

SLA_RESOURCE_TYPE

static final String SLA_RESOURCE_TYPE

Resource type for SLA resources.

See Also:

ConversationID.setResourceType(org.apache.axis.message.addressing.EndpointReferenceType, java.lang.String), Constant Field Values

Method Detail

startActivity

@WebMethod
void startActivity(org.apache.axis.message.addressing.EndpointReferenceType activityEPR,
                             Constraint[] constraints,
                             UsageReport[] reports)
                   throws RemoteException

Check that an activity should be started.

Parameters:

activityEPR - the new resource (must implement ReportAPI port type).

constraints - requirements

Throws:

RemoteException - if the activity should not be started

continueActivity

@WebMethod
void continueActivity(org.apache.axis.message.addressing.EndpointReferenceType activityEPR,
                                Constraint[] constraints)
                      throws RemoteException

Checks that a change in an activity should be permitted.

Parameters:

activityEPR - the new resource (must implement ReportAPI port type).

constraints - the new requirements

Throws:

RemoteException - if the change should be refused

addOwnerRule

@WebMethod
@Deprecated
void addOwnerRule(MatchRule rule)
                  throws RemoteException

Deprecated.

Add a rule controlling who has the 'owner' role.

Parameters:

rule - the rule to add

Throws:

RemoteException

removeOwnerRule

@WebMethod
@Deprecated
void removeOwnerRule(MatchRule rule)
                     throws RemoteException

Deprecated.

Remove a rule controlling who has the 'owner' role.

Parameters:

rule - the rule to add

Throws:

RemoteException

getOwnerRules

@WebMethod
@Deprecated
MatchRule[] getOwnerRules()
                          throws RemoteException

Deprecated.

List the current rules used to determine whether someone has the 'owner' role (which allows them to charge to this account.

Throws:

RemoteException

addUserRule

@WebMethod
@Deprecated
void addUserRule(MatchRule rule)
                 throws RemoteException

Deprecated.

Enable access to an SLA to another user

Parameters:

rule - the rule to add

Throws:

RemoteException

removeUserRule

@WebMethod
@Deprecated
void removeUserRule(MatchRule rule)
                    throws RemoteException

Deprecated.

Disable access to an SLA for a user

Parameters:

rule - the rule to add

Throws:

RemoteException

getUserRules

@WebMethod
@Deprecated
MatchRule[] getUserRules()
                         throws RemoteException

Deprecated.

List the current rules used to determine whether someone has the 'user' role (which allows them to charge to this account.

Throws:

RemoteException

closeSLA

@WebMethod
void closeSLA()
              throws RemoteException

Close an SLA

Throws:

RemoteException

getSLATerms

@WebMethod
SLATemplate getSLATerms()
                        throws RemoteException

Gets the Terms for an SLA

Throws:

RemoteException

getSLAState

@WebMethod
@Deprecated
String getSLAState()
                   throws RemoteException

Deprecated.

Gets the state of an SLA

Throws:

RemoteException

checkUser

@WebMethod
boolean checkUser(SubjectDescription user)
                  throws RemoteException

Test whether this user has the 'user' role.

Parameters:

user - user to test.

Returns:

true if this is a valid user of the SLA, or false if not

Throws:

RemoteException - if the caller is not permitted to check

getUsageSummary

@WebMethod(serverReturnDocumentStyleHack=true)
@Deprecated
Document getUsageSummary()
                         throws RemoteException

Deprecated. see getUsage(java.util.Date, java.util.Date, long, long)

Old way to get usage.

Throws:

RemoteException

getUsage

@WebMethod
SLAUsageSummary getUsage(Date start,
                                   Date end,
                                   long reportInterval,
                                   long maxReports)
                         throws RemoteException

Gets usage reports from an sla

Parameters:

start - the start time of the usage interval to request.

end - the end time of the usage interval to request.

reportInterval - the specified time between reports in milliseconds.

maxReports - the max number of reports to return.

Throws:

RemoteException

Since:

5.1