The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
User-Identity-0.93
River stage two • 1 direct dependent • 15 total dependents
++
/ User::Identity::System

NAME

User::Identity::System - physical system of a person

INHERITANCE

 User::Identity::System
   is a User::Identity::Item

SYNOPSIS

 use User::Identity;
 use User::Identity::System;
 my $me   = User::Identity->new(...);
 my $server = User::Identity::System->new(...);
 $me->add(system => $server);

 # Simpler

 use User::Identity;
 my $me   = User::Identity->new(...);
 my $addr = $me->add(system => ...);

DESCRIPTION

The User::Identity::System object contains the description of the user's presence on a system. The systems are collected by an User::Identity::Collection::Systems object.

Nearly all methods can return undef.

METHODS

Constructors

User::Identity::System->new([NAME], OPTIONS)

    Create a new system. You can specify a name as first argument, or in the OPTION list. Without a specific name, the organization is used as name.

     Option     --Defined in     --Default
 description  User::Identity::Item  undef
 hostname                      'localhost'
 location                      undef
 name         User::Identity::Item  <required>
 os                            undef
 parent       User::Identity::Item  undef
 password                      undef
 username                      undef

    . description => STRING

    . hostname => DOMAIN

      The hostname of the described system. It is prefered to use full system names, not abbreviations. For instance, you can better use www.tux.aq than www to avoid confusion.

    . location => NICKNAME|OBJECT

      The NICKNAME of a location which is defined for the same user. You can also specify a User::Identity::Location OBJECT.

    . name => STRING

    . os => STRING

      The name of the operating system which is run on the server. It is adviced to use the names as used by Perl's $^O variable. See the perlvar man-page for this variable, and perlport for the possible values.

    . parent => OBJECT

    . password => STRING

      The password to be used to login. This password must be un-encoded: directly usable. Be warned that storing un-encoded passwords is a high security list.

    . username => STRING

      The username to be used to login to this host.

Attributes

$obj->description

$obj->hostname

$obj->location

    Returns the object which describes to which location this system relates. The location may be used to find the name of the organization involved, or to create a signature. If no location is specified, undef is returned.

$obj->name([NEWNAME])

$obj->os

$obj->password

$obj->username

Collections

$obj->add(COLLECTION, ROLE)

$obj->addCollection(OBJECT | ([TYPE], OPTIONS))

$obj->collection(NAME)

$obj->find(COLLECTION, ROLE)

$obj->parent([PARENT])

$obj->removeCollection(OBJECT|NAME)

$obj->type

User::Identity::System->type

$obj->user

DIAGNOSTICS

Error: $object is not a collection.

Error: Cannot load collection module for $type ($class).

    Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname.

Error: Creation of a collection via $class failed.

    The $class did compile, but it was not possible to create an object of that class using the options you specified.

Error: Don't know what type of collection you want to add.

    If you add a collection, it must either by a collection object or a list of options which can be used to create a collection object. In the latter case, the type of collection must be specified.

Warning: No collection $name

    The collection with $name does not exist and can not be created.

SEE ALSO

This module is part of User-Identity distribution version 0.93, built on December 24, 2009. Website: http://perl.overmeer.net/userid/

LICENSE

Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html