Interface ATLASCache::AuthTokenCache

interface AuthTokenCache

Operation Index

add_token_with_id

This adds a token to the cache, using the passed cache_id.

add_token_with_profile

This also adds a token to the cache, but the cache_id is either extracted from the profile (if it contains one) or is created from whatever the profile contains.

clear

This will be called to remove and destroy all cached tokens.

flush

This will be called to get rid of any tokens that may have expired.

get_all_tokens

This will be called by the cache builder to get all of the tokens from this cache, so that it can write them to disk.

get_token_with_id

This method is the same as the previous getATLASObject method, except that this method takes a cache_id instead of an ATLASProfile.

get_token_with_profile

This retrieves a token from the cache that has the cache_id from the passed profile.

remove_token_with_id

This is used to remove a single token from the cache.

remove_token_with_profile

This is used to remove a single token from the cache.

Operations

add_token_with_id

boolean add_token_with_id(in ATLAS::ATLASCacheId cache_id,
                          in ATLAS::AuthTokenData token,
                          in boolean overwrite);

This adds a token to the cache, using the passed cache_id.

Parameters:

cache_id - contains the cache identifier added to the IOR by the ATLAS object.

token - contains the authorization token retrieved from the ATLAS object.

overwrite - if this is true, then overwrite any previous token that has the same cache identifier.

add_token_with_profile

boolean add_token_with_profile(in ATLAS::ATLASProfile profile,
                               in ATLAS::AuthTokenData token,
                               in boolean overwrite);

This also adds a token to the cache, but the cache_id is either extracted from the profile (if it contains one) or is created from whatever the profile contains. Currently, a created cache_id consists of the IOR of the ATLAS object from the profile.

Parameters:

profile - contains the profile for the ATLAS object that has been extracted from the IOR of the target object.

token - contains the authorization token retrieved from the ATLAS object.

overwrite - if this is true, then overwrite any previous token that has the same cache identifier.

clear

void clear();

This will be called to remove and destroy all cached tokens.

flush

void flush();

This will be called to get rid of any tokens that may have expired.

get_all_tokens

IdAndTokenList get_all_tokens();

This will be called by the cache builder to get all of the tokens from this cache, so that it can write them to disk.

get_token_with_id

ATLAS::AuthTokenData get_token_with_id(in ATLAS::ATLASCacheId cache_id)
    raises(ATLAS::IllegalTokenRequest);

This method is the same as the previous getATLASObject method, except that this method takes a cache_id instead of an ATLASProfile.

Raises an IllegalTokenRequest exception if the desired token is not found in this cache.

get_token_with_profile

ATLAS::AuthTokenData get_token_with_profile(in ATLAS::ATLASProfile profile)
    raises(ATLAS::IllegalTokenRequest);

This retrieves a token from the cache that has the cache_id from the passed profile.

Raises an IllegalTokenRequest exception if the desired token is not found in this cache.

remove_token_with_id

void remove_token_with_id(in ATLAS::ATLASCacheId cache_id)
    raises(ATLAS::IllegalTokenRequest);

This is used to remove a single token from the cache. The token with the matching cache_id is removed.

Raises an IllegalTokenRequest exception if the desired token is not in this cache.

remove_token_with_profile

void remove_token_with_profile(in ATLAS::ATLASProfile profile)
    raises(ATLAS::IllegalTokenRequest);

This is used to remove a single token from the cache. The token with the matching profile is removed.

Raises an IllegalTokenRequest exception if the desired token is not in this cache.

Generated by the ORBacus IDL-to-HTML translator