summaryrefslogtreecommitdiff
path: root/usr/src/lib/libslp/javalib/com/sun/slp/TemplateRegistry.java
blob: c3cddd0af2e477332eeea70a0a08d9693aa536d1 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 1999 by Sun Microsystems, Inc.
 * All rights reserved.
 *
 */

//  TemplateRegistry.java:
//  Author:           James Kempf
//  Created On:       Fri Jul  4 11:38:39 1997
//  Last Modified By: James Kempf
//  Last Modified On: Mon Jun  1 13:41:07 1998
//  Update Count:     26
//

package com.sun.slp;

import java.util.*;

/**
 * Classes subclassing the <b>TemplateRegistry</b> class register and
 * unregister service templates, look up the template URL's based on the
 * service type name, and return attribute verifiers for verifying
 * template attributes.
 *
 * @author James Kempf
 *
 */

public abstract class TemplateRegistry extends Object {

    protected static TemplateRegistry templateRegistry = null;

    /**
     * The property accessor for the TemplateRegistry.
     *
     * @return The TemplateRegistry object.
     * @exception ServiceLocationException If the registry can't be created.
     */

    public static TemplateRegistry getTemplateRegistry()
	throws ServiceLocationException
    {

	if (templateRegistry == null) {
	    templateRegistry = new SLPTemplateRegistry();

	}

	return templateRegistry;
    }

    /**
     * Register the new service.
     *
     * @param <i>serviceType</i>		Name of the service.
     * @param <i>documentURL</i>		URL of the template document.
     * @param <i>languageLocale</i>	Locale of the template langugae.
     * @param <i>version</i>		Version number of template document.
     * @exception ServiceLocationException If the registration fails.
     * @exception IllegalArgumentException Thrown if any parameters are null.
     *
     */

    abstract public void
	registerServiceTemplate(ServiceType serviceType,
				String documentURL,
				Locale languageLocale,
				String version)
	throws ServiceLocationException;

    /**
     * Deregister the template for service type.
     *
     * @param <i>serviceType</i>	Name of service.
     * @param <i>languageLocale</i> Language locale of template.
     * @param <i>version</i> Version of the template, null for latest.
     * @exception ServiceLocationException Thrown if the template
     *	 		is not registered.
     * @exception IllegalArgumentException Thrown if the serviceType or
     *					  languageLocale parameter is null.
     *
     */

    abstract public void
	deregisterServiceTemplate(ServiceType serviceType,
				  Locale languageLocale,
				  String version)
	throws ServiceLocationException;

    /**
     * Find the document URL for the service.
     *
     * @param <i>serviceType</i>		Name of service.
     * @param <i>languageLocale</i> Language locale of template.
     * @param <i>version</i> Version of the template, null for latest.
     * @return <b>String</b> for the service's template document.
     *         If the service doesn't exist, returns null.
     * @exception ServiceLocationException If more than one template
     *					  document URL is returned.
     *</blockquote>
     * @exception IllegalArgumentException Thrown if the service type or
     *					  languageLocal parameter is null.
     *
     */

    abstract public String
	findTemplateURL(ServiceType serviceType,
			Locale languageLocale,
			String version)
	throws ServiceLocationException;

    /**
     * Create an attribute verifier for the template document URL.
     *
     * @param <i>documentURL</i> A URL for the template document.
     * @return An attribute verifier for the service
     * @exception ServiceLocationException If a parse error occurs or
     *					  if the document can't be found.
     * @exception IllegalArgumentException Thrown if any parameters are null.
     *
     */

    abstract public
	ServiceLocationAttributeVerifier attributeVerifier(String documentURL)
	throws ServiceLocationException;
}