com.sun.jms.spi.JMSAdminFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mq-client Show documentation

The newest version!

/*
 * Copyright (c) 2000, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2022 Contributors to Eclipse Foundation. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.jms.spi;

import jakarta.jms.JMSException;

/**
 * Interface definition to return an instance which implements JMSAdmin.
 */

public interface JMSAdminFactory {

    /**
     * Create/return an instance implementing JMSAdmin.
     *
     * @param jmsAdminURL JMSAdmin URL
     * @return Implementation of JMSAdmin.
     * @exception JMSException thrown if JMSAdmin could not be created/returned.
     */
    JMSAdmin getJMSAdmin(String jmsAdminURL, String userName, String password) throws JMSException;

    /**
     * Create/return an instance implementing JMSAdmin.
     *
     * @param jmsAdminURL JMSAdmin URL
     * @return Implementation of JMSAdmin.
     * @exception JMSException thrown if JMSAdmin could not be created/returned.
     */
    JMSAdmin getJMSAdmin(String jmsAdminURL) throws JMSException;

}