Sonic Management API

com.sonicsw.mq.mgmtapi.config
Interface ICertificatesStoreBean

All Superinterfaces:
IAbstractCertificatesStoreBean, com.sonicsw.mx.config.IAnnotationExtension, IMgmtBase, IMgmtBeanBase

public interface ICertificatesStoreBean
extends IAbstractCertificatesStoreBean

Configuration Bean representing a CertificatesStore


Nested Class Summary
static interface ICertificatesStoreBean.ICertificatesType
          Inner class representing CertificatesType This inner class contains inner data items that are keyed off a name.
 
Nested classes/interfaces inherited from interface com.sonicsw.mq.mgmtapi.config.gen.IAbstractCertificatesStoreBean
IAbstractCertificatesStoreBean.IAbstractCertificatesType
 
Field Summary
 
Fields inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
C_VERSION_PROPERTY, CLASS_PROPERTY, P_VERSION_PROPERTY, TEMPLATE_PROPERTY, TYPE_PROPERTY
 
Fields inherited from interface com.sonicsw.mx.config.IAnnotationExtension
END_CDATA, START_CDATA, TOOL_ANNOTATION
 
Method Summary
 void addCertificate(java.lang.String certificateLocation)
          Add valid certificate to the CertificatesStoreBean.
 void addCertificates(java.lang.String[] certificateLocations)
          Add valid certificates to the CertificatesStoreBean.
 java.util.List getCertificatesLocations()
          Returns List of certificates locations added to the CertificatesStore
 void removeCertificate(java.lang.String path)
          Remove certificate from CertificatesStoreBean.
 
Methods inherited from interface com.sonicsw.mq.mgmtapi.config.gen.IAbstractCertificatesStoreBean
getCertificates, getCertificatesMetaData
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
clone, createUniqueName, getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getProperty, getReferenceAttribute, getStringAttribute, isNewBean, setBigDecimalAttribute, setBooleanAttribute, setByteArrayAttribute, setIntegerAttribute, setLongAttribute, setReferenceAttribute, setStringAttribute
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBase
getAttributeList, getAttributeMap, getAttributeMetaData, getConfigBean, getConfigBeanName, getConfigBeanNameTail, getConfigPath, getConfigPath, getMgmtBeanFactory, getParent, removeAttribute, setAttribute
 
Methods inherited from interface com.sonicsw.mx.config.IAnnotationExtension
getAnnotation, setAnnotation
 

Method Detail

addCertificate

void addCertificate(java.lang.String certificateLocation)
                    throws MgmtException
Add valid certificate to the CertificatesStoreBean.

Parameters:
certificateLocation, - specifies the certificate file location in underlying DS.
Throws:
MgmtException - Thrown when location is not valid reference(user must use sonicfs url format) or location points to the not valid certificate.

addCertificates

void addCertificates(java.lang.String[] certificateLocations)
                     throws MgmtException
Add valid certificates to the CertificatesStoreBean.

Parameters:
certificateLocations. - specifies an array of certificate file locations in underlying DS.
Throws:
MgmtException - Thrown when location is not valid reference(user must use sonicfs url format) or location points to the not valid certificate.

getCertificatesLocations

java.util.List getCertificatesLocations()
                                        throws MgmtException
Returns List of certificates locations added to the CertificatesStore

Throws:
MgmtException - Thrown when can't obtain list of certificates locations.

removeCertificate

void removeCertificate(java.lang.String path)
                       throws MgmtException
Remove certificate from CertificatesStoreBean.

Parameters:
path, - specifies certificate file location.
Throws:
MgmtException - Thrown when location reference can't be removed.

Sonic Management API

Copyright © 2001-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.