01: /*
02: * Copyright 2002 Sun Microsystems, Inc. All
03: * rights reserved. Use of this product is subject
04: * to license terms. Federal Acquisitions:
05: * Commercial Software -- Government Users
06: * Subject to Standard License Terms and
07: * Conditions.
08: *
09: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
10: * are trademarks or registered trademarks of Sun Microsystems,
11: * Inc. in the United States and other countries.
12: */
13:
14: package com.sun.portal.container;
15:
16: /**
17: * A container provides an execution environment in which channels' contents
18: * are generated. It is a distinct component separate from the portal server's
19: * aggregation mechanism. The <code>Container</code> interface defines the
20: * rule of interaction between the aggregation and the container.
21: **/
22: public interface Container {
23:
24: /**
25: * Gets the markup segment from a channel to be aggregated with other
26: * channels to form a portal page.
27: * <p>
28: * @param request <code>GetMarkupRequest</code> object contains information
29: * for containers to process the request.
30: * @param response <code>GetMarkupResponse</code> object for containers to
31: * return the result back to the aggregation engine.
32: *
33: * @exception <code>ContainerException</code> when an error occurs in the
34: * container code.
35: * @exception <code>ContentException</code> when an error occurs in the
36: * content generation code.
37: **/
38: public void getMarkup(GetMarkupRequest request,
39: GetMarkupResponse response) throws ContainerException,
40: ContentException;
41:
42: /**
43: * Executes an action of a channel.
44: * <p>
45: * @param request <code>ExecuteActionRequest</code> object contains
46: * informatiuon for containers to process the request.
47: * @param response <code>ExecuteActionResponse</code> object for containers
48: * to return the result back to the aggregation engine.
49: *
50: * @exception <code>ContainerException</code> when an error occurs in the
51: * container code.
52: * @exception <code>ContentException</code> when an error occurs in the
53: * process action code.
54: **/
55: public void executeAction(ExecuteActionRequest request,
56: ExecuteActionResponse response) throws ContainerException,
57: ContentException;
58:
59: /**
60: * Gets the Resource information for a channel
61: * <p>
62: * @param request <code>GetResourceRequest</code> object contains
63: * informatiuon for containers to process the request.
64: * @param response <code>GetResourceResponse</code> object for containers
65: * to return the result back to the aggregation engine.
66: *
67: * @exception <code>ContainerException</code> when an error occurs in the
68: * container code.
69: *
70: ***/
71: public void getResources(GetResourceRequest request,
72: GetResourceResponse response) throws ContainerException;
73: }
|