Edward Kawas > lsid-perl > LS::Client

Download:
lsid-perl-1.1.7.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

LS::Client - Base module for building LSID clients

SYNOPSIS ^

 package MyClient;

 use vars qw(@ISA);

 use LS::Client;

 @ISA = ( 'LS::Client' );


 sub new {

   # Your client implementation 
 }

DESCRIPTION ^

The LS::Client module is used as a base class when building LSID clients.

METHODS ^

credentials( $crd_object )
        Sets/Gets the credentials object specified by crd_object.
        If crd_object is omitted, the current credentials are 
        returned.

COPYRIGHT AND LICENSE ^

Copyright (c) 2002,2003 IBM Corporation All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.opensource.org/licenses/cpl.php

NAME ^

LS::Client::Credentials - Modules used to manipulate user credentials

SYNOPSIS ^

 my $credentials = LS::Client::Credentials->new();

 $credentials->username( 'username' );
 $credentials->password( 'password' );

 ... elsewhere in your application ...

 if($credentials->username() eq 'username') {

     # Do something
 }

DESCRIPTION ^

The LS::Client::Credentials object is used as a standard way to pass user credentials in the framework.

METHODS ^

username( [ $username ] )
        Gets the username if no parameter is specified.

                        - OR -

        Sets the username to the specified parameter.
password ( [ $password ] )
        Gets the password if no parameter is specified.

                        - OR -

        Sets the password to the specified parameter.

COPYRIGHT AND LICENSE ^

Copyright (c) 2002,2003 IBM Corporation All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.opensource.org/licenses/cpl.php

syntax highlighting: