NAME

Solstice::Service::LoginRealm - Provides mapping between user login and login realm objects.

SYNOPSIS

 use Solstice::Service::LoginRealm;

 my $service = Solstice::Service::LoginRealm->new();

 # Three ways to get a login realm...
 my $login_realm = $service->getByID('5');
 
 $login_realm = $service->getByScope('washington.edu');
 
 $login_realm = $service->getByLogin('jsmith@washington.edu'); 

 my $login_name = $service->getLoginNameForLogin('jsmith@washington.edu');
 # returns 'jsmith'
 
 my $scope = $service->getScopeForLogin('jsmith@u.washington.edu');
 # returns 'washington.edu'

 # Get the current user login
 my $login = $service->getLogin();

DESCRIPTION

Solstice::Service::LoginRealm is a service for getting a login realm object for a given login string.

Several other methods are also provided which are designed to be overridable in a subclass:

getLoginNameForLogin() returns the login name for a login string. getScopeForLogin() returns the scope for a login string.

Finally, getLogin() returns the login of the currently logged-in user.

Export

None by default.

Methods

new()

getByScope($scope)

Returns a login realm identified by the passed $scope string.

getByID($id)

Returns a login realm identified by the passed $id.

getByLogin($login)

Returns a login realm identified by the passed $login string.

getLoginNameForLogin($login)

Returns the login name for the passed $login string.

getScopeForLogin($login)

Returns the login realm scope for the passed $login string.

getLogin()

Returns the current user login, in this implementation from $ENV{REMOTE_USER}. Only accessible in an auth container, does not look at the user in session.

Private Methods

_init()

AUTHOR

Educational Technology Development Group <catalyst@u.washington.edu>

VERSION

$Revision: 597 $

SEE ALSO

COPYRIGHT

Copyright 1998-2007 Office of Learning Technologies, University of Washington

Licensed under the Educational Community License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.opensource.org/licenses/ecl1.php

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.