01: /*
02: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
04: *
05: * This program is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU General Public License version
07: * 2 only, as published by the Free Software Foundation.
08: *
09: * This program is distributed in the hope that it will be useful, but
10: * WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * General Public License version 2 for more details (a copy is
13: * included at /legal/license.txt).
14: *
15: * You should have received a copy of the GNU General Public License
16: * version 2 along with this work; if not, write to the Free Software
17: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18: * 02110-1301 USA
19: *
20: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
21: * Clara, CA 95054 or visit www.sun.com if you need additional
22: * information or have any questions.
23: */
24:
25: package com.sun.midp.push.gcf;
26:
27: import javax.microedition.io.ConnectionNotFoundException;
28:
29: /**
30: * Factory class to produce <code>ReservationDescriptor</code>s.
31: */
32: public interface ReservationDescriptorFactory {
33: /**
34: * Returns push reservation descriptor.
35: *
36: * <p>
37: * Validates parameters passed, checks connection permissions and if
38: * everything's fine, creates an instance of {@link ReservationDescriptor}
39: * which would allow to reserve the connection.
40: * </p>
41: *
42: * @param connectionName same as <code>connection</code> parameter
43: * passed into
44: * {@link javax.microedition.io.PushRegistry#registerConnection}
45: * (cannot be <code>null</code>)
46: *
47: * @param filter filter as passed into
48: * {@link javax.microedition.io.PushRegistry#registerConnection}
49: * (cannot be <code>null</code>)
50: *
51: * @param permissionCallback callback to check permissions (cannot be
52: * <code>null</code>, use dummy implementation if there is need to bypass
53: * security checks)
54: *
55: * @return connection descriptor (always not <code>null</code>)
56: *
57: * @throws IllegalArgumentException if the connection string is not valid,
58: * or if the filter string is not valid
59: *
60: * @throws ConnectionNotFoundException if the runtime system does not
61: * support push delivery for the requested connection protocol
62: */
63: ReservationDescriptor getDescriptor(String connectionName,
64: String filter, PermissionCallback permissionCallback)
65: throws IllegalArgumentException,
66: ConnectionNotFoundException;
67: }
|