01: /**
02: * $$
03: * Copyright 2004 Sun Microsystems, Inc. All
04: * rights reserved. Use of this product is subject
05: * to license terms. Federal Acquisitions:
06: * Commercial Software -- Government Users
07: * Subject to Standard License Terms and
08: * Conditions.
09: *
10: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
11: * are trademarks or registered trademarks of Sun Microsystems,
12: * Inc. in the United States and other countries.
13: */package com.sun.ssoadapter.mbeans;
14:
15: import java.util.List;
16: import java.util.Map;
17: import java.util.Properties;
18:
19: import com.sun.portal.admin.common.util.AdminUtil;
20: import com.sun.portal.admin.common.PSMBeanException;
21:
22: public interface SSOAdapterMBean {
23: // Global DN string to be used to access global configurations
24: public static final String GLOBAL_DN = "_!global!_";
25:
26: // Type definition set in the AdminUtil
27: public static final String TYPE = AdminUtil.SSOADAPTER_MBEAN_TYPE;
28:
29: // Return a list of all the template names available
30: public List getTemplateNames() throws PSMBeanException;
31:
32: // Return a map of property names and their values for a template
33: // The map of the template contains:
34: // attribute names and values for default properties,
35: // an attribute named "merge" whos value is a List of merge properties,
36: // an attribute named "encoded" whos value is a List of encoded properties.
37: public Map getTemplateProperties(String name)
38: throws PSMBeanException;
39:
40: // Set properties of a template, replacing the current properties
41: // The map of the template contains:
42: // attribute names and values for default properties,
43: // an attribute named "merge" whos value is a List of merge properties,
44: // an attribute named "encoded" whos value is a List of encoded properties.
45: public void setTemplateProperties(String name, Map properties)
46: throws PSMBeanException;
47:
48: // Create a new global template based off an existing template
49: public void createTemplate(String name, String basis)
50: throws PSMBeanException;
51:
52: // Delete a global template.
53: // User is responsible for deleting all configurations that reference the template
54: public void deleteTemplate(String name) throws PSMBeanException;
55:
56: // Return a map of all the configuration names and associated templates available for a given dn
57: // Each key in the map is a configuration name, the value is a String representing the template
58: // basis of the configuration
59: public Map getConfigurationNamesByDn(String dn)
60: throws PSMBeanException;
61:
62: // Return a map of all the configuration names and associated dns available for a given template
63: // Each key in the map is a configuration name, the value is a List of Strings representing dns
64: // that have that configuration defined
65: public Map getConfigurationNamesByTemplate(String template)
66: throws PSMBeanException;
67:
68: // Return a map of property names and their values for a configuration and dn
69: public Map getConfigurationProperties(String dn, String name)
70: throws PSMBeanException;
71:
72: // Set property values for a configuration and dn, replacing all existing properties
73: public void setConfigurationProperties(String dn, String name,
74: Map properties) throws PSMBeanException;
75:
76: // Create a new configuration for given dn
77: public void createConfiguration(String dn, String name, String basis)
78: throws PSMBeanException;
79:
80: // Delete a configuration for a given dn
81: public void deleteConfiguration(String dn, String name)
82: throws PSMBeanException;
83:
84: // Return a list of all role and org dns which have the sso adapter service template defined
85: public List getDnsWithConfigurations() throws PSMBeanException;
86:
87: // Return a list of authless users that can use the sso adapter service without authentication
88: public List getAuthorizedAuthlessUsers() throws PSMBeanException;
89:
90: // Set the list of authless users that can use the sso adapter service without authentication
91: public void setAuthorizedAuthlessUsers(List userDns)
92: throws PSMBeanException;
93:
94: // Return a whether or not the dn has the SSOAdapter service registered
95: public Boolean hasSSOAdapterService(String dn)
96: throws PSMBeanException;
97: }
|