uk.ac.soton.itinnovation.grid.comms.dataresource
Interface DataResource

All Superinterfaces:

PolicyManagement, ResourceMetadata, WSResourceLifetime

All Known Subinterfaces:

OgsaDaiResource, OgsaDaiResourceConversation

All Known Implementing Classes:

ManagedDataResource, OgsaDaiServiceI2Impl, OgsaDaiServiceImpl

@WebServiceWSDL(targetNamespace="http://www.it-innovation.soton.ac.uk/2004/grid/dataresource",
                portTypeName="DataResource",
                resourcePath="dataresource.wsdl",
                serviceName="DataResource",
                bindingName="DataResourceSoapBinding")
public interface DataResource
extends WSResourceLifetime, ResourceMetadata, PolicyManagement

Field Summary

static String

RESOURCE_TYPE

Method Summary

org.apache.axis.message.addressing.EndpointReferenceType	connectDataResourceRole(String parentDataResourceID, MatchRule owner, String label, Map<String,String> attributes, String metricURI) Connect an existing role.
org.apache.axis.message.addressing.EndpointReferenceType	createDataResourceRole(String parentDataResourceID, MatchRule owner, String label, Map<String,String> attributes, String metricURI) Create a role on the data resource backend.
Map<String,String>	getDataResourceAttributes() Get the attribute values of this data resource.
void	modifyDataResource(String label, Map<String,String> attributes) Modify parts of this data resource.

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

destroy

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

getEPR, setLabel

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

addPolicyRule, getPolicyRules, getValidRoles, removePolicyRule

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

createDataResourceRole

@WebMethod(usesBillingHeader=true)
org.apache.axis.message.addressing.EndpointReferenceType createDataResourceRole(String parentDataResourceID,
                                                                                                           MatchRule owner,
                                                                                                           String label,
                                                                                                           Map<String,String> attributes,
                                                                                                           String metricURI)
                                                                                throws RemoteException

Create a role on the data resource backend. Unlike connectDataResourceRole(java.lang.String, uk.ac.soton.itinnovation.grid.types.MatchRule, java.lang.String, java.util.Map, java.lang.String), this method actually creates the role on the backend before returning a resource representing it. Normally this method will be hidden from SOAP users, and only called by DataResourceManager.createDefaultRoles(uk.ac.soton.itinnovation.grid.types.MatchRule, uk.ac.soton.itinnovation.grid.service.dataresource.beans.DataResourceBean, uk.ac.soton.itinnovation.grid.comms.dataresource.DataResource, java.lang.String). metricURI should typically be ignored if this method were to be called by SOAP users, as it only makes sense for the service administrator to specify metrics.

Parameters:

parentDataResourceID - The resourceID of the DataResource that this role applies to. If null, the resourceID is fetched from the context of the SOAP operation.

owner - A rule for the 'owner' PBAC role.

label - A label describing the role that is to be created.

attributes - A key-value map of attributes describing the credentials for this role. Keys should be from the set DataResourceManagement.getDataResourceRoleAttributeNames().

metricURI - The URI of a custom metric for this role. Typically ignored when provided over SOAP.

Returns:

An EPR describing the role

Throws:

RemoteException

connectDataResourceRole

@WebMethod(usesBillingHeader=true)
org.apache.axis.message.addressing.EndpointReferenceType connectDataResourceRole(String parentDataResourceID,
                                                                                                            MatchRule owner,
                                                                                                            String label,
                                                                                                            Map<String,String> attributes,
                                                                                                            String metricURI)
                                                                                 throws RemoteException

Connect an existing role. Unlike createDataResourceRole(java.lang.String, uk.ac.soton.itinnovation.grid.types.MatchRule, java.lang.String, java.util.Map, java.lang.String), this method does not create the role on the backend and the credentials specified in attributes should describe a valid existing role. metricURI should typically be ignored when this method is called by SOAP users, as it only makes sense for the service administrator to specify metrics.

Parameters:

parentDataResourceID - The resourceID of the DataResource that this role applies to. If null, the resourceID is fetched from the context of the SOAP operation.

owner - A rule for the 'owner' PBAC role.

label - A label describing the role that is to be created.

attributes - A key-value map of attributes describing the credentials for this role. Keys should be from the set DataResourceManagement.getDataResourceRoleAttributeNames().

metricURI - The URI of a custom metric for this role. Typically ignored when provided over SOAP.

Returns:

An EPR describing the role

Throws:

RemoteException

getDataResourceAttributes

@WebMethod
Map<String,String> getDataResourceAttributes()

Get the attribute values of this data resource. The return type is a key-value map of attributes. Keys will be from the set DataResourceManagement.getDataResourceAttributeNames().

modifyDataResource

@WebMethod
void modifyDataResource(String label,
                                  Map<String,String> attributes)

Modify parts of this data resource.

Parameters:

label - The new label. If null, the label will not be changed.

attributes - A new key-value map of attributes. Any attributes not specified in this map will not be modified or removed. Keys should be of the set DataResourceManagement.getDataResourceAttributeNames().