User::Identity::System(3pm)

1User::Identity::System(U3s)er Contributed Perl DocumentatUisoenr::Identity::System(3)
2
3
4

NAME

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

INHERITANCE

9        User::Identity::System
10          is an User::Identity::Item
11

SYNOPSIS

13        use User::Identity;
14        use User::Identity::System;
15        my $me   = User::Identity->new(...);
16        my $server = User::Identity::System->new(...);
17        $me->add(system => $server);
18
19        # Simpler
20
21        use User::Identity;
22        my $me   = User::Identity->new(...);
23        my $addr = $me->add(system => ...);
24

DESCRIPTION

26       The "User::Identity::System" object contains the description of the
27       user's presence on a system.  The systems are collected by an
28       User::Identity::Collection::Systems object.
29
30       Nearly all methods can return undef.
31

METHODS

33       Constructors
34
35       User::Identity::System->new([NAME], OPTIONS)
36
37           Create a new system.  You can specify a name as first argument, or
38           in the OPTION list.  Without a specific name, the organization is
39           used as name.
40
41            Option     --Defined in     --Default
42            description  User::Identity::Item  undef
43            hostname                      'localhost'
44            location                      undef
45            name         User::Identity::Item  <required>
46            os                            undef
47            parent       User::Identity::Item  undef
48            password                      undef
49            username                      undef
50
51           . description STRING
52
53           . hostname DOMAIN
54
55               The hostname of the described system.  It is prefered to use
56               full system names, not abbreviations.  For instance, you can
57               better use "www.tux.aq" than "www" to avoid confusion.
58
59           . location NICKNAME⎪OBJECT
60
61               The NICKNAME of a location which is defined for the same user.
62               You can also specify a User::Identity::Location OBJECT.
63
64           . name STRING
65
66           . os STRING
67
68               The name of the operating system which is run on the server.
69               It is adviced to use the names as used by Perl's $^O variable.
70               See the perlvar man-page for this variable, and perlport for
71               the possible values.
72
73           . parent OBJECT
74
75           . password STRING
76
77               The password to be used to login.  This password must be
78               un-encoded: directly usable.  Be warned that storing un-encoded
79               passwords is a high security list.
80
81           . username STRING
82
83               The username to be used to login to this host.
84
85       Attributes
86
87       $obj->description
88
89           See "Attributes" in User::Identity::Item
90
91       $obj->hostname
92
93       $obj->location
94
95           Returns the object which describes to which location this system
96           relates.  The location may be used to find the name of the organi‐
97           zation involved, or to create a signature.  If no location is spec‐
98           ified, undef is returned.
99
100       $obj->name([NEWNAME])
101
102           See "Attributes" in User::Identity::Item
103
104       $obj->os
105
106       $obj->password
107
108       $obj->username
109
110       Collections
111
112       $obj->add(COLLECTION, ROLE)
113
114           See "Collections" in User::Identity::Item
115
116       $obj->addCollection(OBJECT ⎪ ([TYPE], OPTIONS))
117
118           See "Collections" in User::Identity::Item
119
120       $obj->collection(NAME)
121
122           See "Collections" in User::Identity::Item
123
124       $obj->find(COLLECTION, ROLE)
125
126           See "Collections" in User::Identity::Item
127
128       $obj->parent([PARENT])
129
130           See "Collections" in User::Identity::Item
131
132       $obj->removeCollection(OBJECT⎪NAME)
133
134           See "Collections" in User::Identity::Item
135
136       $obj->type
137
138       User::Identity::System->type
139
140           See "Collections" in User::Identity::Item
141
142       $obj->user
143
144           See "Collections" in User::Identity::Item
145

DIAGNOSTICS

147       Error: $object is not a collection.
148
149       The first argument is an object, but not of a class which extends
150       User::Identity::Collection.
151
152       Error: Cannot load collection module for $type ($class).
153
154       Either the specified $type does not exist, or that module named $class
155       returns compilation errors.  If the type as specified in the warning is
156       not the name of a package, you specified a nickname which was not
157       defined.  Maybe you forgot the 'require' the package which defines the
158       nickname.
159
160       Error: Creation of a collection via $class failed.
161
162       The $class did compile, but it was not possible to create an object of
163       that class using the options you specified.
164
165       Error: Don't know what type of collection you want to add.
166
167       If you add a collection, it must either by a collection object or a
168       list of options which can be used to create a collection object.  In
169       the latter case, the type of collection must be specified.
170
171       Warning: No collection $name
172
173       The collection with $name does not exist and can not be created.
174

LICENSE

180       Copyrights 2003,2004,2007 by Mark Overmeer <perl@overmeer.net>.For
181       other contributors see Changes.
182
183       This program is free software; you can redistribute it and/or modify it
184       under the same terms as Perl itself.  See
185       http://www.perl.com/perl/misc/Artistic.html
186
187
188
189perl v5.8.8                       2007-01-08         User::Identity::System(3)