Package openid :: Package consumer :: Module discover :: Class OpenIDServiceEndpoint
[frames] | no frames]

Class OpenIDServiceEndpoint

source code

object --+
         |
        OpenIDServiceEndpoint

Object representing an OpenID service endpoint.

Instance Methods
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
usesExtension(self, extension_uri) source code
 
preferredNamespace(self) source code
 
supportsType(self, type_uri)
Does this endpoint support this type?
source code
 
getDisplayIdentifier(self)
Return the display_identifier if set, else return the claimed_id.
source code
 
compatibilityMode(self) source code
 
isOPIdentifier(self) source code
 
parseService(self, yadis_url, uri, type_uris, service_element)
Set the state of this object based on the contents of the service element.
source code
 
getLocalID(self)
Return the identifier that should be sent as the openid.identity parameter to the server.
source code
 
__str__(self)
str(x)
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Class Methods
 
fromBasicServiceEndpoint(cls, endpoint)
Create a new instance of this class from the endpoint object passed in.
source code
[OpenIDServiceEndpoint]
fromHTML(cls, uri, html)
Parse the given document as HTML looking for an OpenID <link rel=...>
source code
[OpenIDServiceEndpoint]
fromXRDS(cls, uri, xrds)
Parse the given document as XRDS looking for OpenID services.
source code
list of OpenIDServiceEndpoint
fromDiscoveryResult(cls, discoveryResult)
Create endpoints from a DiscoveryResult.
source code
OpenIDServiceEndpoint
fromOPEndpointURL(cls, op_endpoint_url)
Construct an OP-Identifier OpenIDServiceEndpoint object for a given OP Endpoint URL
source code
Class Variables
  openid_type_uris = ['http://specs.openid.net/auth/2.0/server',...
Instance Variables
  canonicalID
For XRI, the persistent identifier.
  identity_url
the verified identifier.
Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

supportsType(self, type_uri)

source code 

Does this endpoint support this type?

I consider /server endpoints to implicitly support /signon.

fromBasicServiceEndpoint(cls, endpoint)
Class Method

source code 

Create a new instance of this class from the endpoint object passed in.

Returns:
None or OpenIDServiceEndpoint for this endpoint object

fromXRDS(cls, uri, xrds)
Class Method

source code 

Parse the given document as XRDS looking for OpenID services.

Returns: [OpenIDServiceEndpoint]
Raises:
  • XRDSError - When the XRDS does not parse.

Since: 2.1.0

fromDiscoveryResult(cls, discoveryResult)
Class Method

source code 

Create endpoints from a DiscoveryResult.

Parameters:
Returns: list of OpenIDServiceEndpoint
Raises:
  • XRDSError - When the XRDS does not parse.

Since: 2.1.0

fromOPEndpointURL(cls, op_endpoint_url)
Class Method

source code 

Construct an OP-Identifier OpenIDServiceEndpoint object for a given OP Endpoint URL

Parameters:
  • op_endpoint_url - The URL of the endpoint
Returns: OpenIDServiceEndpoint

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

Class Variable Details

openid_type_uris

Value:
['http://specs.openid.net/auth/2.0/server',
 'http://specs.openid.net/auth/2.0/signon',
 'http://openid.net/signon/1.1',
 'http://openid.net/signon/1.0']