RealityServer Web Services API Programmer's Manual

mi::rswservices::IUrl_configuration Class Reference

[Configuration]

Description

Configuration for a URL.

Public Member Functions

virtual bool  get_apply_uac() const =0
Returns whether the URL is involved in user access control. More...
virtual const char* get_authorizer() const =0
Returns the name of the Authorizer configured for this URL pattern. More...
virtual const char* get_pattern() const =0
Returns the URL pattern that this configuration applies to.
virtual const char* get_redirect() const =0
Returns the URL that this URL redirects to. More...
virtual const char* get_state( mi::Size index) const =0
Returns the name of the index State configured for this URL pattern. More...

Member Functions

virtual bool mi::​rswservices::​IUrl_configuration::get_apply_uac() const [pure virtual]

Returns whether the URL is involved in user access control.

Returns

true if user access limits are applied when accessing this URL, false otherwise.

virtual const char* mi::​rswservices::​IUrl_configuration::get_authorizer() const [pure virtual]

Returns the name of the Authorizer configured for this URL pattern.

Returns

the authorizer or NULL if none configured.

virtual const char* mi::​rswservices::​IUrl_configuration::get_pattern() const [pure virtual]

Returns the URL pattern that this configuration applies to.

virtual const char* mi::​rswservices::​IUrl_configuration::get_redirect() const [pure virtual]

Returns the URL that this URL redirects to.

Returns

the redirect or NULL if no redirection configured.

virtual const char* mi::​rswservices::​IUrl_configuration::get_state( mi::Size index) const [pure virtual]

Returns the name of the index State configured for this URL pattern. To iterate over all states for a url this method can be called incrementing index by one until NULL is returned.

Parameters

index
The index of the state to return.

Returns

the state or NULL if none configured for index .