com.pivotal.gemfirexd.internal.client.am.FailedProperties40 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snappydata-store-client Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 
   Derby - Class com.pivotal.gemfirexd.internal.client.am.FailedProperties40
 
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 
 */

package com.pivotal.gemfirexd.internal.client.am;

import java.util.Properties;
import java.util.Enumeration;
import java.util.Map;
import java.util.HashMap;
import java.sql.SQLClientInfoException;
import java.sql.ClientInfoStatus;

    /**
     * Class FailedProperties40 is a helper class for
     * java.sql.SQLClientInfoException. It provides
     * convenient access to data that is needed when constructing
     * those exceptions. Should be kept in sync with its embedded
     * counter part.
     * @see java.sql.SQLClientInfoException
     * @see com.pivotal.gemfirexd.internal.iapi.jdbc.FailedProperties40
     */
public class FailedProperties40 {
    private final HashMap failedProps_ = 
	new HashMap();

    private final String firstKey_;
    private final String firstValue_;

    /**
     * Helper method that creates a Propery object with the name-value
     * pair given as arguments.
     * @param name property key
     * @param value property value
     * @return the created Properties object
     */
    public static Properties makeProperties(String name, String value) {
	Properties p = new Properties();
        if (name != null || value != null)
            p.setProperty(name, value);
	return p;
    }
    
    /**
     * Creates a new FailedProperties40 instance. Since
     * Derby doesn't support any properties, all the keys from the
     * props parameter are added to the
     * failedProps_ member with value
     * REASON_UNKNOWN_PROPERTY.
     *
     * @param props a Properties value. Can be null or empty
     */   
    public FailedProperties40(Properties props) {
        if (props == null || props.isEmpty()) {
            firstKey_ = null;
            firstValue_ = null;
            return;
        }
        Enumeration e = props.keys();
        firstKey_ = (String)e.nextElement();
        firstValue_ = props.getProperty(firstKey_);
        failedProps_.put(firstKey_, ClientInfoStatus.REASON_UNKNOWN_PROPERTY);
        while (e.hasMoreElements()) {
            failedProps_.put((String)e.nextElement(), 
                             ClientInfoStatus.REASON_UNKNOWN_PROPERTY);
        }
    }

    /**
     * getProperties provides a
     * Map object describing the
     * failed properties (as specified in the javadoc for
     * java.sql.SQLClientInfoException).
     *
     * @return a Map object with
     * the failed property keys and the reason why each failed
     */
    public Map getProperties() { return failedProps_; }

    /**
     * getFirstKey returns the first property key. Used
     * when SQLClientInfoException is thrown with a parameterized error
     * message.
     *
     * @return a String value
     */
    public String getFirstKey() { return firstKey_; }

    /**
     * getFirstValue returns the first property value. Used
     * when SQLClientInfoException is thrown with a parameterized error
     * message.
     *
     * @return a String value
     */
    public String getFirstValue() { return firstValue_; }
}