Class GridProxy

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

(inherited documentation)

Choose command set to be used for proxy-related commands

No arguments other than self

If self.voms has a null value then the GridCommand set of commands is used. Otherwise the VomsCommand set of commands is used.

Return value: None

Create credential.

Arguments other than self:
   validity    - Validity with which credential should be created,
                 specified as string of format "hh:mm"
                 [ Defaults to value of self.validityAtCreation ]
   maxTry      - Number of password attempts allowed
                 [ Defaults to value of self.maxTry ]
   minValidity - Minimum validity in case checking of
                 pre-existing credential is performed,
                 specified as strong of format "hh:mm"
                 [ Defaults to value of self.minValidity ]
   check       - Flag to request checking of pre-existing
                 credential; if flag is set to true, then new
                 credential is created only if the validity of
                 any pre-existing credential is less than the
                 value of minValidity
                 [ Default: False ] 

Note: create is the same as renew, except for the default value of check

Return value: True if credential is created successfully, and False
otherwise.

Overrides: ICredential.ICredential.create

(inherited documentation)

Destroy credential

Argument other than self:
   allowed_exit - List of exit codes accepted without error
                  when issuing system command for destroying credential

Return value: False if command for destroying credential is undefined,
              or True otherwise

Overrides: ICredential.ICredential.destroy

(inherited documentation)

Check whether credential is available with system/configuration used

No arguments other than self

Return value: True if credential is available, false otherwise

Overrides: ICredential.ICredential.isAvailable

(inherited documentation)

Check validity

Arguments other than self:
   validity    - Minimum time for which credential should be valid,
                 specified as string of format "hh:mm"
                 [ Defaults to valud of self.minValidity ]

   log         - Print logger messages if credential not valid 

   force_check - Force credential check, rather than relying on cache

Return value: True if credential is valid for required time, False
otherwise.

Overrides: ICredential.ICredential.isValid

(inherited documentation)

Determine credential location

No arguments other than self

Return value: Path to credential if found, or empty string otherwise

Overrides: ICredential.ICredential.location

(inherited documentation)

Return the users full identity as a dictionary

Argument:
   safe - logical flag
          =>  False : return identity exactly as obtained from proxy
          =>  True  : return identity after stripping out
                      non-alphanumeric characters

Return value: Dictionary of the various labels in the users DN

Return user's identify

Argument:
   safe - logical flag
          =>  False : return identity exactly as obtained from proxy
          =>  True  : return identity after stripping out
                      non-alphanumeric characters

=> The identity is determined from the user proxy if possible,
   or otherwise from the user's top-level directory

Return value: String specifying user identity

Obtain proxy information

Arguments other than self:
   opt         - String of options to be used when querying
                 proxy information
               => Help on valid options can be obtained using:
                  info( opt = "-help" )
   force_check - Force credential check, rather than relying on cache

Return value: Output from result of querying proxy

Renew credential.

Arguments other than self:
   validity    - Validity with which credential should be created,
                 specified as string of format "hh:mm"
                 [ Defaults to value of self.validityAtCreation ]
   maxTry      - Number of password attempts allowed
                 [ Defaults to value of self.maxTry ]
   minValidity - Minimum validity in case checking of
                 pre-existing credential is performed,
                 specified as strong of format "hh:mm"
                 [ Defaults to value of self.minValidity ]
   check       - Flag to request checking of pre-existing
                 credential; if flag is set to true, then new
                 credential is created only if the validity of
                 any pre-existing credential is less than the
                 value of minValidity
                 [ Default: True ] 

Note: renew is the same as create, except for the default value of check

Return value: True if new credential is created successfully, and False
otherwise.

Overrides: ICredential.ICredential.renew

(inherited documentation)

Check time for which credential is valid.

Arguments other than self:
   units       - String specifying units in which time is returned

   force_check - Force credential check, rather than relying on cache

Allowed values for units are:
   "hours"              - time returned as in hours
   "minutes"            - time returned in minutes
   "seconds"            - time returned in seconds
   "hh:mm:ss" [default] - time returned as hours, minutes seconds


Return value: Credential validity as string giving time in requested
   units, or empty string if command for querying credential validity
   is unavailable

Overrides: ICredential.ICredential.timeleft

(inherited documentation)

Determine remaining validity of credential in hours, minutes and seconds

Argument other than self:
   force_check - Force credential check, rather than relying on cache

Return value: String giving credential validity, or empty string
   if command for querying credential validity is unavailable

Overrides: ICredential.ICredential.timeleftInHMS

(inherited documentation)

Obtain name of virtual organisation from proxy

Argument other than self:
   force_check - Force credential check, rather than relying on cache

Return value: Name of virtual organisation where this can be determined
(voms proxy), or empty string otherwise (globus proxy)

Check the proxy cache for the required key. Make sure the proxy file is older than the last check.

opt - the key to check for

Test the result of grid proxy call and add to the cache if all OK

status - the status output output - the output text opt - opt to add