org.cagrid.gaards.cds.client
Class DelegationUserClient

java.lang.Object
  org.cagrid.gaards.cds.client.DelegationUserClient

public class DelegationUserClient
extends java.lang.Object

Constructor Summary

DelegationUserClient(java.lang.String url)

DelegationUserClient(java.lang.String url, org.globus.gsi.GlobusCredential cred)

Method Summary

DelegatedCredentialReference	delegateCredential(DelegationPolicy policy, ProxyLifetime issuedCredentialLifetime) This method allows a user to delegated their credential to the Credential Delegation Service
DelegatedCredentialReference	delegateCredential(ProxyLifetime delegationLifetime, DelegationPolicy policy, ProxyLifetime issuedCredentialLifetime) This method allows a user to delegated their credential to the Credential Delegation Service
DelegatedCredentialReference	delegateCredential(ProxyLifetime delegationLifetime, int delegationPathLength, DelegationPolicy policy, ProxyLifetime issuedCredentialLifetime, int issuedCredentialPathLength, int keyLength) This method allows a user to delegated their credential to the Credential Delegation Service
java.util.List<DelegationDescriptor>	findCredentialsDelegatedToClient() This method obtains a list of credentials that have been delegated to this client by other clients.
java.util.List<DelegationDescriptor>	findCredentialsDelegatedToClient(ClientDelegationFilter filter) This method obtains a list of credentials that have been delegated to this client by other clients.
java.util.List<DelegationDescriptor>	findCredentialsDelegatedToClient(java.lang.String ownerGridIdentity) This method obtains a list of credentials that have been delegated to this client by other clients.
java.util.List<DelegationRecord>	findMyDelegatedCredentials() This method allows a user to find credentials that they delegated.
java.util.List<DelegationRecord>	findMyDelegatedCredentials(DelegationRecordFilter filter) This method allows a user to find credentials that they delegated.
java.util.List<DelegatedCredentialAuditRecord>	searchDelegatedCredentialAuditLog(DelegatedCredentialAuditFilter f) Allows one to search the audit logs from Delegated Credential(s).
void	suspendDelegatedCredential(DelegationIdentifier id) This method suspends a delegated credential such that no further credentials will be delegated/issued.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegationUserClient

public DelegationUserClient(java.lang.String url)
                     throws java.lang.Exception

Throws:

java.lang.Exception

DelegationUserClient

public DelegationUserClient(java.lang.String url,
                            org.globus.gsi.GlobusCredential cred)
                     throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

delegateCredential

public DelegatedCredentialReference delegateCredential(DelegationPolicy policy,
                                                       ProxyLifetime issuedCredentialLifetime)
                                                throws java.rmi.RemoteException,
                                                       CDSInternalFault,
                                                       DelegationFault,
                                                       PermissionDeniedFault,
                                                       org.apache.axis.types.URI.MalformedURIException

This method allows a user to delegated their credential to the Credential Delegation Service

Parameters:

policy - The policy specifying who may request this delegated credential from the Credential Delegation Service

issuedCredentialLifetime - The life time of the credentials delegated to entities by the Credential Delegation Service on you behalf.

Returns:

A reference to the delegated credential, this reference may be used by entites to request a credential.

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationFault

PermissionDeniedFault

URI.MalformedURIException

delegateCredential

public DelegatedCredentialReference delegateCredential(ProxyLifetime delegationLifetime,
                                                       DelegationPolicy policy,
                                                       ProxyLifetime issuedCredentialLifetime)
                                                throws java.rmi.RemoteException,
                                                       CDSInternalFault,
                                                       DelegationFault,
                                                       PermissionDeniedFault,
                                                       org.apache.axis.types.URI.MalformedURIException

This method allows a user to delegated their credential to the Credential Delegation Service

Parameters:

delegationLifetime - The life time of the credential being delegated to the Credential Delegation Service. This lifetime specifies how long the Credential Delegation Service may delegate this credential.

policy - The policy specifying who may request this delegated credential from the Credential Delegation Service

issuedCredentialLifetime - The life time of the credentials delegated to entities by the Credential Delegation Service on you behalf.

Returns:

A reference to the delegated credential, this reference may be used by entites to request a credential.

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationFault

PermissionDeniedFault

URI.MalformedURIException

delegateCredential

public DelegatedCredentialReference delegateCredential(ProxyLifetime delegationLifetime,
                                                       int delegationPathLength,
                                                       DelegationPolicy policy,
                                                       ProxyLifetime issuedCredentialLifetime,
                                                       int issuedCredentialPathLength,
                                                       int keyLength)
                                                throws java.rmi.RemoteException,
                                                       CDSInternalFault,
                                                       DelegationFault,
                                                       PermissionDeniedFault,
                                                       org.apache.axis.types.URI.MalformedURIException

This method allows a user to delegated their credential to the Credential Delegation Service

Parameters:

delegationLifetime - The life time of the credential being delegated to the Credential Delegation Service. This lifetime specifies how long the Credential Delegation Service may delegate this credential.

delegationPathLength - The delegation path length of the credential being delegated to the Credential Delegation Service.

policy - The policy specifying who may request this delegated credential from the Credential Delegation Service

issuedCredentialLifetime - The life time of the credentials delegated to entities by the Credential Delegation Service on you behalf.

issuedCredentialPathLength - The path length of the credentials delegated to entities by the Credential Delegation Service on you behalf. A path length of 0 means that entities that can you obtain a delegated credential cannot further delegate it.

keyLength - The key length of the signing credential.

Returns:

A reference to the delegated credential, this reference may be used by entites to request a credential.

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationFault

PermissionDeniedFault

URI.MalformedURIException

findMyDelegatedCredentials

public java.util.List<DelegationRecord> findMyDelegatedCredentials()
                                                            throws java.rmi.RemoteException,
                                                                   CDSInternalFault,
                                                                   DelegationFault,
                                                                   PermissionDeniedFault

This method allows a user to find credentials that they delegated.

Returns:

A list of records each representing a credential delegated by the user

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationInternalFault

PermissionDeniedFault

DelegationFault

findMyDelegatedCredentials

public java.util.List<DelegationRecord> findMyDelegatedCredentials(DelegationRecordFilter filter)
                                                            throws java.rmi.RemoteException,
                                                                   CDSInternalFault,
                                                                   DelegationFault,
                                                                   PermissionDeniedFault

This method allows a user to find credentials that they delegated.

Parameters:

filter - Search criteria to use in finding delegated credentials

Returns:

A list of records each representing a credential delegated by the user

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationInternalFault

PermissionDeniedFault

DelegationFault

suspendDelegatedCredential

public void suspendDelegatedCredential(DelegationIdentifier id)
                                throws java.rmi.RemoteException,
                                       CDSInternalFault,
                                       DelegationFault,
                                       PermissionDeniedFault

This method suspends a delegated credential such that no further credentials will be delegated/issued.

Parameters:

id - The delegation identifier of the delegated credentials to suspend.

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationFault

PermissionDeniedFault

findCredentialsDelegatedToClient

public java.util.List<DelegationDescriptor> findCredentialsDelegatedToClient()
                                                                      throws java.rmi.RemoteException,
                                                                             CDSInternalFault,
                                                                             PermissionDeniedFault

This method obtains a list of credentials that have been delegated to this client by other clients.

Returns:

A list of credentials delegated to this client.

Throws:

java.rmi.RemoteException

CDSInternalFault

PermissionDeniedFault

findCredentialsDelegatedToClient

public java.util.List<DelegationDescriptor> findCredentialsDelegatedToClient(java.lang.String ownerGridIdentity)
                                                                      throws java.rmi.RemoteException,
                                                                             CDSInternalFault,
                                                                             PermissionDeniedFault

This method obtains a list of credentials that have been delegated to this client by other clients.

Parameters:

ownerGridIdentity - The grid identity of the owner to restrict this search to.

Returns:

A list of credentials delegated to this client.

Throws:

java.rmi.RemoteException

CDSInternalFault

PermissionDeniedFault

findCredentialsDelegatedToClient

public java.util.List<DelegationDescriptor> findCredentialsDelegatedToClient(ClientDelegationFilter filter)
                                                                      throws java.rmi.RemoteException,
                                                                             CDSInternalFault,
                                                                             PermissionDeniedFault

This method obtains a list of credentials that have been delegated to this client by other clients.

Parameters:

filter - Search criteria to use in filtering credentials

Returns:

A list of credentials delegated to this client.

Throws:

java.rmi.RemoteException

CDSInternalFault

PermissionDeniedFault

searchDelegatedCredentialAuditLog

public java.util.List<DelegatedCredentialAuditRecord> searchDelegatedCredentialAuditLog(DelegatedCredentialAuditFilter f)
                                                                                 throws java.rmi.RemoteException,
                                                                                        CDSInternalFault,
                                                                                        DelegationFault,
                                                                                        PermissionDeniedFault

Allows one to search the audit logs from Delegated Credential(s).

Parameters:

f - The search criteria

Returns:

Returns a list of audit records meeting the search criteria

Throws:

java.rmi.RemoteException

CDSInternalFault

DelegationFault

PermissionDeniedFault