aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/ApplicationPlugins/Rest/Inventory/IRestHandler.cs
blob: f67f8b1038877937d3e90622965275ada0c2d076 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSim Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */

using System;
using OpenSim.Framework.Servers;

namespace OpenSim.ApplicationPlugins.Rest.Inventory
{

    /// <remarks>
    /// The handler delegates are not noteworthy. The allocator allows
    /// a given handler to optionally subclass the base RequestData
    /// structure to carry any locally required per-request state
    /// needed.
    /// </remarks>

    public delegate void        RestMethodHandler(RequestData rdata);
    public delegate RequestData RestMethodAllocator(OSHttpRequest request, OSHttpResponse response);
 
    /// <summary>
    /// This interface represents the boundary between the general purpose
    /// REST plugin handling, and the functionally specific handlers. The
    /// handler knows only to initialize and terminate all such handlers 
    /// that it finds. Implementing this interface identifies the class as
    /// a REST handler implementation.
    /// </summary>

    internal interface IRestHandler
    {

        string MsgId     { get; }
        string RequestId { get; }
    
        void   AddPathHandler(RestMethodHandler mh, string path, RestMethodAllocator ma);
        void AddStreamHandler(string httpMethod, string path, RestMethod method);

    }

}