LS::Client - Base module for building LSID clients


lsid-perl documentation  | view source Contained in the lsid-perl distribution.

Index


NAME

Top

LS::Client - Base module for building LSID clients

SYNOPSIS

Top

 package MyClient;

 use vars qw(@ISA);

 use LS::Client;

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




 sub new {

   # Your client implementation 
 }

DESCRIPTION

Top

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

METHODS

Top

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

Top

NAME

Top

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

SYNOPSIS

Top

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

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

 ... elsewhere in your application ...

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

     # Do something
 }

DESCRIPTION

Top

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

METHODS

Top

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

Top


lsid-perl documentation  | view source Contained in the lsid-perl distribution.