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

DIAGNOSTICS

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

LICENSE

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