=encoding utf8

=head1 NAME

=begin original

HTTP::WebTest::Plugin::Cookies - Send and recieve cookies in tests

=end original

HTTP::WebTest::Plugin::Cookies - テスト時のクッキーの送受信

=head1 SYNOPSIS

=begin original

Not Applicable

=end original

なし.

=head1 DESCRIPTION

=begin original

This plugin provides means to control sending and recieve cookies in
web test.

=end original

このプラグインではウェブテスト時のクッキーの送受信を制御する手段を
提供します.

=head1 TEST PARAMETERS

(テストパラメータ)

=head2 accept_cookies

=begin original

Option to accept cookies from the web server.

=end original

ウェブサーバからクッキーを受けつかるかの設定.

=begin original

These cookies exist only while the program is executing and do not
affect subsequent runs.  These cookies do not affect your browser or
any software other than the test program.  These cookies are only
accessible to other tests executed during test sequence execution.

=end original

クッキーはプログラムの実行中にだけ存在し, それ以降は影響を与えません. 
これらのクッキーはあなたのブラウザやテストプログラム以外のソフトウェア
には影響しません. クッキーは１つのテストシーケンス中で実行している
他のテストからだけアクセスできます.

=begin original

See also the <send_cookies> parameter.

=end original

<send_cookies> パラメータも参照してください.

=head3 Allowed values

(使用可能な値)

C<yes>, C<no>


=head3 Default value

(デフォルト値)

C<yes>


=head2 send_cookies

=begin original

Option to send cookies to web server.  This applies to cookies
received from the web server or cookies specified using the C<cookies>
test parameter.

=end original

ウェブサーバのクッキーを送るかを設定します. これはウェブサーバから
受け取ったクッキーにも C<cookies> テストパラメータで指定された
クッキーにも適用されます.

=begin original

This does NOT give the web server(s) access to cookies created with a
browser or any user agent software other than this program.  The
cookies created while this program is running are only accessible to
other tests in the same test sequence.

=end original

これはウェブサーバにブラウザや他のこのプログラム以外のユーザエージェント
ソフトウェアが作ったクッキーへのアクセスを禁じるものではありません. 
このプログラムの実行中に生成されたクッキーは同じテストシーケンス内の
他のテストからのみアクセス可能です.

=begin original

See also the <accept_cookies> parameter.

=end original

<accept_cookies> パラメータも参照してください.

=head3 Allowed values

(使用可能な値)

C<yes>, C<no>


=head3 Default value

(デフォルト値)

C<yes>


=head2 cookie

=begin original

Synonym to C<cookies>.

=end original

C<cookies> の同義語です.

=begin original

It is deprecated parameter and may be removed in future versions of
L<HTTP::WebTest|HTTP::WebTest>.

=end original

このパラメータは廃止されています. 今後のバージョンの
L<HTTP::WebTest|HTTP::WebTest> で削除されるでしょう.

=head2 cookies

=begin original

This is a list parameter that specifies cookies to send to the web
server:

=end original

ウェブサーバに送るクッキーを指定したリストを指定します:

    cookies = ( cookie1_spec
                cookie2_spec
                ...
                cookieN_spec )

=begin original

Currently there are two ways to specify a cookie.

=end original

現在のところ２種類の記述方法があります.

=over 4

=item * Named style

* 名前付きスタイル

=begin original

A cookie is specified by a set of C<param =E<gt> value> pairs:

=end original

クッキーは C<param =E<gt> value> ペアの集合で指定します:

    (
      param => value
      ...
    )

=begin original

List of all supported C<param =E<gt> value> pairs:

=end original

サポートされている C<param =E<gt> value>  ペアは以下の通りです:

=over 4

=item version => VERSION

=begin original

Version number of cookie spec to use, usually 0.

=end original

使用するクッキー指定方法のバージョン番号. 通常は 0 を指定します.

=item name => NAME (REQUIRED)

=begin original

Name of cookie.  Cannot begin with a $ character.

=end original

クッキーの名前. 文字 $ で始まる名前は使えません.

=item value => VALUE (REQUIRED)

=begin original

Value of cookie.

=end original

クッキーの値.

=item path => PATH (REQUIRED)

=begin original

URL path name for which this cookie applies.  Must begin with a /
character.  See also path_spec.

=end original

このクッキーが適用される url パス. 文字 / で始まらなければなりません. 
path_spec も参照してください.

=item domain => DOMAIN (REQUIRED)

=begin original

Domain for which cookie is valid.  Must either contain two periods or
be equal to C<.local>.

=end original

クッキーを有効にするドメイン. ２つのピリオドを含むか C<.local> と
等しくなければなりません.

=item port => PORT

=begin original

List of allowed port numbers that the cookie may be returned to.  If
not specified, cookie can be returned to any port.  Must be specified
using the format C<N> or C<N, N, ..., N> where N is one or more
digits.

=end original

クッキーを返すことを許可するポート番号のリスト. 
指定しなければ全てのポートに対して返すようになります. 
C<N> もしくは C<N, N, ..., N> というフォーマットして指定してください
(N は１つ以上の数字です).

=item path_spec => PATH_SPEC

=begin original

Ignored if version is less than 1.  Option to ignore the value of
path.  Default value is 0.

=end original

version が 1 より小さいときは無視されます. 
path の値を無視するかどうかを設定します. デフォルトは 0 です.

=over 4

=item * 1

=begin original

Use the value of path.

=end original

path の値を使う.

=item * 0

=begin original

Ignore the specified value of path.

=end original

path に指定された値を無視する.

=back

=item secure => SECURE

=begin original

Option to require secure protocols for cookie transmission.  Default
value is 0.

=end original

クッキーの転送にセキュアなプロトコルを要求する. 
デフォルトは 0.

=over 4

=item * 1

=begin original

Use only secure protocols to transmit this cookie.

=end original

このクッキーはセキュアなプロトコルでのみ使われる.

=item * 0

=begin original

Secure protocols are not required for transmission.

=end original

転送時にセキュアなプロトコルを必要としない.

=back

=item maxage => MAXAGE

=begin original

Number of seconds until cookie expires.

=end original

クッキーが期限切れとなるまでの秒数.

=item discard => DISCARD

=begin original

Option to discard cookie when the program finishes.  Default is 0.
(The cookie will be discarded regardless of the value of this
element.)

=end original

プログラムが終了するときにクッキーを破棄するかの設定. 
デフォルトは 0. 
(クッキーはこの要素の値に関わらず破棄されます.)

=over 4

=item * 1

=begin original

Discard cookie when the program finishes.

=end original

プログラム終了時にクッキーを破棄する.

=item * 0

=begin original

Don't discard cookie.

=end original

クッキーを破棄しない.

=back

=item rest => NAME_VALUE_LIST

=begin original

Defines additional cookie attributes.

=end original

クッキーの属性を追加定義する.

=begin original

Zero, one or several name/value pairs may be specified.  The name
parameters are words such as Comment or CommentURL and the value
parameters are strings that may contain embedded blanks.

=end original

0個, 1個, それ以上の名前/値ペアを指定します. 
名前は Comment や CommentURL といった単語を, 値には文字列(空白を
含むこともできます)を指定します.

=back

=begin original

Example (wtscript file):

=end original

例 (wtscript ファイル):

    cookies = ( ( name   => Cookie1
                  value  => cookie value )

                ( name   => Cookie2
                  value  => cookie value
                  path   => /
                  domain => .company.com ) )

                ( name   => Cookie2
                  value  => cookie value
                  rest   => ( Comment => this is a comment ) )

=begin original

Example (Perl script):

=end original

例 (Perl スクリプト):

    my $tests = [
                  ...
                  {
                    test_name => 'cookie',
                    cookies   => [ [
                                     name  => 'Cookie1',
                                     value => 'Value',
                                   ],
                                   [
                                     name  => 'Cookie2',
                                     value => 'Value',
                                     path  => '/',
                                   ] ],
                    ...
                  }
                  ...
                ]

=item * Row list style

(行リストスタイル)

=begin original

This style of cookie specification is deprecated and may be removed in
future versions of L<HTTP::WebTest|HTTP::WebTest>.

=end original

この形式での指定は廃止されています. 
今後のバージョンの L<HTTP::WebTest|HTTP::WebTest> で削除されるでしょう.

=begin original

Each cookie is specified by following list:

=end original

各クッキーは以下のリストの形で指定されます:

    ( VERSION
      NAME
      VALUE
      PATH
      DOMAIN
      PORT
      PATH_SPEC
      SECURE
      MAXAGE
      DISCARD
      NAME1
      VALUE1
      NAME2
      VALUE2
      ...
    )

=begin original

Any element not marked below as REQUIRED may be defaulted by
specifying a null value or ''.

=end original

以下で REQUIRED とマークされている要素はnull値もしくは
'' がデフォルトになります.

=over 4

=item * VERSION (REQUIRED)

=begin original

Version number of cookie spec to use, usually 0.

=end original

使用するクッキー指定方法のバージョン番号. 通常は 0 を指定します.

=item * NAME (REQUIRED)

=begin original

Name of cookie.  Cannot begin with a $ character.

=end original

クッキーの名前. 文字 $ で始まる名前は使えません.

=item * VALUE (REQUIRED)

=begin original

Value of cookie.

=end original

クッキーの値.

=item * PATH (REQUIRED)

=begin original

URL path name for which this cookie applies.  Must begin with a /
character.  See also path_spec.

=end original

このクッキーが適用される url パス. 文字 / で始まらなければなりません. 
path_spec も参照してください.

=item * DOMAIN (REQUIRED)

=begin original

Domain for which cookie is valid.  Must either contain two periods or
be equal to C<.local>.

=end original

クッキーを有効にするドメイン. ２つのピリオドを含むか C<.local> と
等しくなければなりません.

=item * PORT

=begin original

List of allowed port numbers that the cookie may be returned to.  If
not specified, cookie can be returned to any port.  Must be specified
using the format C<N> or C<N, N, ..., N> where N is one or more
digits.

=end original

クッキーを返すことを許可するポート番号のリスト. 
指定しなければ全てのポートに対して返すようになります. 
C<N> もしくは C<N, N, ..., N> というフォーマットして指定してください
(N は１つ以上の数字です).

=item * PATH_SPEC

=begin original

Ignored if version is less than 1.  Option to ignore the value of
path.  Default value is 0.

=end original

version が 1 より小さいときは無視されます. 
path の値を無視するかどうかを設定します. デフォルトは 0 です.

=over 4

=item * 1

=begin original

Use the value of path.

=end original

path の値を使う.

=item * 0

=begin original

Ignore the specified value of path.

=end original

path に指定された値を無視する.

=back

=item * SECURE

=begin original

Option to require secure protocols for cookie transmission.  Default
value is 0.

=end original

クッキーの転送にセキュアなプロトコルを要求する. 
デフォルトは 0.

=over 4

=item * 1

=begin original

Use only secure protocols to transmit this cookie.

=end original

このクッキーはセキュアなプロトコルでのみ使われる.

=item * 0

=begin original

Secure protocols are not required for transmission.

=end original

転送時にセキュアなプロトコルを必要としない.

=back

=item * MAXAGE

=begin original

Number of seconds until cookie expires.

=end original

クッキーが期限切れとなるまでの秒数.

=item * DISCARD

=begin original

Option to discard cookie when the program finishes.  Default is 0.
(The cookie will be discarded regardless of the value of this
element.)

=end original

プログラムが終了するときにクッキーを破棄するかの設定. 
デフォルトは 0. 
(クッキーはこの要素の値に関わらず破棄されます.)

=over 4

=item * 1

=begin original

Discard cookie when the program finishes.

=end original

プログラム終了時にクッキーを破棄する.

=item * 0

=begin original

Don't discard cookie.

=end original

クッキーを破棄しない.

=back

=item * name/value

=begin original

Zero, one or several name/value pairs may be specified.  The name
parameters are words such as Comment or CommentURL and the value
parameters are strings that may contain embedded blanks.

=end original

0個, 1個, それ以上の名前/値ペアを指定します. 
名前は Comment や CommentURL といった単語を, 値には文字列(空白を
含むこともできます)を指定します.

=back

=begin original

An example cookie would look like:

=end original

例えば次のようになります:

    cookies = ( ( 0
                  WebTest cookie #1
                  cookie value
                  /
                  .mycompany.com
                  ''
                  0
                  0
                  200
                  1
                ) )

=back

=begin original

See RFC 2965 for details (ftp://ftp.isi.edu/in-notes/rfc2965.txt).

=end original

詳細は RFC 2965 (ftp://ftp.isi.edu/in-notes/rfc2965.txt) を
参照してください.

=head1 COPYRIGHT

Copyright (c) 2000-2001 Richard Anderson.  All rights reserved.


Copyright (c) 2001-2003 Ilya Martynov.  All rights reserved.


=begin original

This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=end original

このプログラムはフリーソフトです. このプログラムは Perl 自身と同じ条件下で
再配布・改変可能です.

=head1 SEE ALSO

L<HTTP::WebTest|HTTP::WebTest>


L<HTTP::WebTest::API|HTTP::WebTest::API>


L<HTTP::WebTest::Plugin|HTTP::WebTest::Plugin>


L<HTTP::WebTest::Plugins|HTTP::WebTest::Plugins>