annotate Lib/IMPL/Web/Application/Resource.pm @ 233:3cebcf6fdb9b

refactoring, cleaning code
author sergey
date Thu, 11 Oct 2012 04:53:08 +0400
parents 6d8092d8ce1b
children a02b110da931
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
1 package IMPL::Web::Application::Resource;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
2 use strict;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
3
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
4 use IMPL::Const qw(:prop);
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
5 use IMPL::declare {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
6 require => {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
7 Exception => 'IMPL::Exception',
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
8 ArgumentException => '-IMPL::InvalidArgumentException',
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
9 OperationException => '-IMPL::InvalidOperationException',
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
10 NotAllowedException => 'IMPL::Web::NotAllowedException',
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
11 NotFoundException => 'IMPL::Web::NotFoundException'
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
12 },
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
13 base => [
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
14 'IMPL::Object' => undef,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
15 'IMPL::Web::Application::ResourceInterface' => undef
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
16 ],
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
17 props => [
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
18 parent => PROP_GET | PROP_OWNERSET,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
19 model => PROP_GET | PROP_OWNERSET,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
20 id => PROP_GET | PROP_OWNERSET,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
21 contract => PROP_GET | PROP_OWNERSET,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
22 location => PROP_GET | PROP_OWNERSET
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
23 ]
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
24 };
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
25
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
26 sub CTOR {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
27 my ( $this, %args ) = @_;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
28
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
29 die ArgumentException->new( id => 'A resource identifier is required' )
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
30 unless $args{id};
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
31 die ArgumentException->new( contract => 'A contract is required' )
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
32 unless $args{id};
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
33
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
34 $this->parent( $args{parent} );
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
35 $this->model( $args{model} );
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
36 $this->id( $args{id} );
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
37 $this->contract( $args{contract} );
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
38
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
39 # если расположение явно не указано, то оно вычисляется автоматически,
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
40 # либо остается не заданным
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
41 $this->location( $args{location} || eval { $this->parent->location->Child( $this->id ) } );
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
42 }
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
43
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
44 sub InvokeHttpVerb {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
45 my ( $this, $verb, $action ) = @_;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
46
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
47 my $operation = $this->contract->verbs->{ lc($verb) };
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
48
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
49 die NotAllowedException->new(
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
50 allow => join( ',', map( uc, keys %{ $this->contract->verbs } ) )
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
51 )
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
52 unless $operation;
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
53
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
54 return $operation->Invoke( $this, $action );
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
55 }
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
56
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
57 # это реализация по умолчанию, базируется информации о ресурсах, содержащийся
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
58 # в контракте.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
59 sub FetchChildResource {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
60 my ( $this, $childId ) = @_;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
61
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
62 my ($info,$childIdParts) = $this->contract->FindChildResourceInfo($childId);
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
63
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
64 die NotFoundException->new($this->location->url,$childId) unless $info;
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
65
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
66 my $binding = $info->{binding};
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
67 my $contract = $info->{contract}
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
68 or die OperationException->new("Can't fetch a contract for the resource", $childId);
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
69
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
70 my %args = (
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
71 parent => $this,
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
72 id => $childId
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
73 );
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
74
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
75 $args{model} = _InvokeDelegate($binding,$this,@$childIdParts);
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
76
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
77 return $contract->CreateResource(%args);
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
78 }
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
79
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
80 sub _InvokeDelegate {
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
81 my $delegate = shift;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
82
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
83 return $delegate->(@_) if ref $delegate eq 'CODE';
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
84 return $delegate->Invoke(@_) if eval { $delegate->can('Invoke')};
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
85 }
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
86
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
87 1;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
88
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
89 __END__
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
90
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
91 =pod
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
92
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
93 =head1 NAME
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
94
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
95 C<IMPL::Web::Application::Resource> - Web-ресурс.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
96
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
97 =head1 SYNOPSIS
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
98
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
99 Класс для внутреннего использования. Объединяет в себе контракт и модель данных.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
100 Основная задача - обработать поступающий от контроллера запрос на вызов C<HTTP>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
101 метода.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
102
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
103 Экземпляры данного класса передаются в качестве параметров делегатам
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
104 осуществляющим привязку к модели в C<IMPL::Web::Application::ResourceContract>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
105 и C<IMPL::Web::Application::OperationContract>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
106
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
107 =head1 DESCRIPTION
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
108
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
109 Весь функционал ресурса, поддерживаемые им C<HTTP> методы определяются
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
110 контрактом. Однако можно реализовывать ресурсы, которые не имеют контракта
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
111 или он отличается от того, что предоставляется стандартно
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
112 C<IMPL::Web::Application::ResourceContract>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
113
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
114 Каждый ресурс является контейнером, тоесть позволяет получить дочерний ресурс
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
115 по идентифифкатору, если таковой имеется, тоесть ресурс, у которого нет дочерних
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
116 ресурсов на самом деле рассматривается как пустой контейнер.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
117
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
118 С ресурсом непосредственно взаимодействует котроллер запросов
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
119 C<IMPL::Web::Handler::RestController>, вызывая два метода.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
120
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
121 =over
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
122
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
123 =item * C<FetchChildResource($childId)>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
124
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
125 Данный метод возвращает дочерний ресурс, соответствующий C<$childId>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
126 Текущая реализация использует метод C<FindChildResourceInfo> контракта текущего
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
127 ресурса, после чего создает дочерний ресурс.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
128
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
129 Если дочерний ресурс не найден, вызывается исключение
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
130 C<IMPL::Web::NotFoundException>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
131
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
132 =item * C<InvokeHttpVerb($verb,$action)>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
133
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
134 Обрабатывает запрос к ресурсу. Для этого используется контракт ресурса, в
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
135 нем выбирается соответсвующий C<IMPL::Web::Application::OperationContract>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
136 Затем найденный контракт для указанной операции используется для обработки
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
137 запроса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
138
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
139 =back
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
140
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
141 Если объект реализует два вышеуказанных метода, он является веб-ресурсом, а
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
142 детали его реализации, котнракт и прочее уже не важно, поэтому можно реализовать
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
143 собственный класс ресурса, например унаследованный от
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
144 C<IMPL::Web::Application::CustomResource>.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
145
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
146 =head1 MEMBERS
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
147
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
148 =head2 C<[get]contract>
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
149
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
150 Обязательное свойство для ресурса, ссылается, на контракт, соотсетствующий
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
151 данному ресурсу, используется для выполнения C<HTTP> методов и получения
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
152 дочерних ресурсов.
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
153
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
154 =head2 C<[get]id>
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
155
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
156 Обязательное свойство ресурса, идентифицирует его в родительском контейнере,
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
157 для корневого ресурса может иметь произвольное значение.
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
158
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
159 =head2 C<[get]parent>
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
160
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
161 Ссылка на родительский ресурс, для корневого ресурса не определена.
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
162
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
163 =head2 C<[get]model>
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
164
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
165 Ссылка на объект предметной области, представляемый данным ресурсом. Данное
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
166 свойство не является обязательным и может быть не задано.
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
167
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
168 =head2 C<[get]location>
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
169
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
170 Объект типа C<IMPL::Web::AutoLocator> или аналогичный описывающий адрес текущего
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
171 ресурса, может быть как явно передан при создании ресурса, так и вычислен
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
172 автоматически (только для ресурсов имеющих родителя). Следует заметить, что
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
173 адрес ресурса не содержит параметров запроса, а только путь.
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 229
diff changeset
174
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents:
diff changeset
175 =cut