KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > profileservice > spi > ProfileService


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22
23 package org.jboss.profileservice.spi;
24
25 import org.jboss.deployers.spi.management.ManagementView;
26
27 /**
28  * The entry point service for accessing/administiring server profiles
29  *
30  * @todo this should be broken up into different feature plugin services
31  *
32  * @author Scott.Stark@jboss.org
33  * @version $Revision$
34  */
35 public interface ProfileService
36 {
37    // Querying profiles
38
39    /**
40     * Get the unique domains for which profiles exist
41     * @return array of profile domains
42     */
43    public String JavaDoc[] getDomains();
44
45    /**
46     * Get the keys for all known profiles
47     * @return keys for all known profiles
48     */
49    public ProfileKey[] getProfileKeys();
50
51    /**
52     * Obtain the profile for the key.
53     *
54     * @param key - the key for the profile
55     * @return the matching profile.
56     * @throws NoSuchProfileException
57     */
58    public Profile getProfile(ProfileKey key)
59       throws NoSuchProfileException;
60
61    /**
62     * Get a list of the deployment names associated with a profile.
63     * @param key - the key for the profile
64     * @return the list of deployment names.
65     * @throws NoSuchProfileException
66     */
67    public String JavaDoc[] getProfileDeploymentNames(ProfileKey key)
68       throws NoSuchProfileException;
69
70    /**
71     * Obtain the ManagementView plugin
72     * @return the ManagementView plugin if supported
73     */
74    public ManagementView getViewManager();
75
76    // Admin of profiles @todo could be an option plugin
77 public Profile newProfile(ProfileKey key);
78    public void removeProfile(ProfileKey key)
79       throws NoSuchProfileException;
80
81 }
82
Popular Tags