How to use

warn

method

in

net.shibboleth.utilities.java.support.primitive.DeprecationSupport

  /**
   * Constructor.  Added purely to generate the deprecation warning.
   */
  public AbstractDataConnectorParser() {
    super();
    DeprecationSupport.warn(ObjectType.CLASS, this.getClass().getName(), null, super.getClass().getName());
  }
}

/**
 * {@inheritDoc}
 *
 * @deprecated Use {@link #setAttributeNames} instead
 * @see        #setAttributeNames
 */
@Override @Deprecated public void setDependencyAttributeId(@Nullable final String attributeId) {
  DeprecationSupport.warn(ObjectType.METHOD,
      "ResolverDataConnectorDependency#setDependencyAttributeId(String)",
      null, "#setAttributeNames(Collection<String>)");
  super.setDependencyAttributeId(attributeId);
}

/** {@inheritDoc} */
@Override
protected void doInitialize() throws ComponentInitializationException {
  super.doInitialize();
  
  DeprecationSupport.warn(ObjectType.CLASS, getClass().getName(), null, null);
}

/**
 * Constructor.
 * 
 * @param query to search the database
 * @deprecated - use the property setters
 */
@Deprecated public FormatExecutableStatementBuilder(@Nonnull final String query) {
  DeprecationSupport.warn(ObjectType.METHOD, "FormatExecutableStatementBuilder(String)", null, null);
  sqlQuery = Constraint.isNotNull(query, "SQL query can not be null");
}

/**
 * Constructor.
 * 
 * @param attrName the name to filter on.
 * @deprecated use the property setter instead
 */
@Deprecated public IdPAttributePrincipalValuesFunction(@Nonnull final String attrName) {
  attributeName = Constraint.isNotNull(attrName, "Attribute Name should be non-null");
  DeprecationSupport.warn(ObjectType.METHOD, 
      "IdPAttributePrincipalValuesFunction(String)", null, null);
}

/**
 * Constructor.
 * 
 * @param file file to output to.
 * @throws FileNotFoundException if the file cannot be found.
 */
public MetadataGenerator(@Nonnull final File file) throws FileNotFoundException {
  DeprecationSupport.warn(ObjectType.CLASS, this.getClass().getName(), null , ".impl");
  final File nonnullFile = Constraint.isNotNull(file, "provided file must be nonnull");
  final FileOutputStream outStream = new FileOutputStream(nonnullFile);
  writer = new BufferedWriter(new OutputStreamWriter(outStream));
  endpoints = EnumSet.allOf(Endpoints.class);
}

  /** {@inheritDoc} */
  @Override
  public void execute() {
    DeprecationSupport.warn(ObjectType.CLASS, this.getClass().getName(), null , ".impl");
    try {
      tool.changeKey();
    } catch (final Exception e) {
      log("Build failed", e, Project.MSG_ERR);
      throw new BuildException(e);
    }
  }
}

  @Override 
  /** {@inheritDoc} */
  public void execute() {
    DeprecationSupport.warn(ObjectType.CLASS, this.getClass().getName(), null , ".impl");
    try {
      generator.generate();
    } catch (final Exception e) {
      log("Build failed", e, Project.MSG_ERR);
      throw new BuildException(e);
    }
  }
}

/** {@inheritDoc} */
@Override
protected void doInitialize() throws ComponentInitializationException {
  
  for (final Map.Entry<String,String> entry : deprecatedProperties.entrySet()) {
    if (applicationContext.getEnvironment().containsProperty(entry.getKey())) {
      DeprecationSupport.warn(ObjectType.PROPERTY, entry.getKey(), null, entry.getValue());
    }
  }
  for (final String name : deadProperties) {
    if (applicationContext.getEnvironment().containsProperty(name)) {
      log.warn("property '{}' is no longer supported", name);
    }
  }
}

/** {@inheritDoc} */
@Override protected void doInitialize() throws ComponentInitializationException {
  super.doInitialize();
  if (null == idGenerator) {
    throw new ComponentInitializationException("Id generator must be non null");
  }
  
  DeprecationSupport.warn(ObjectType.CLASS, getClass().getName(), null, "via NameID Generation configuration");
}

/** {@inheritDoc} */
@Override protected void doNativeParse(@Nonnull final Element element, @Nonnull final ParserContext parserContext,
    @Nonnull final BeanDefinitionBuilder builder) {
  super.doNativeParse(element, parserContext, builder);
  
  DeprecationSupport.warn(ObjectType.XSITYPE, SCHEMA_TYPE_AFP.toString(),
      parserContext.getReaderContext().getResource().getDescription(), null);
}

/**
 * Creates a new V2Parser with the supplied LDAPDirectory element.
 * 
 * @param config LDAPDirectory element
 * @param prefix the parent's log prefix
 */
public V2Parser(@Nonnull final Element config, @Nonnull final String prefix) {
  Constraint.isNotNull(config, "LDAPDirectory element cannot be null");
  configElement = config;
  logPrefix = prefix; 
  // warn about deprecated (removed?) attribute
  if (AttributeSupport.hasAttribute(config, new QName("mergeResults"))) {
    DeprecationSupport.warn(ObjectType.ATTRIBUTE,  "mergeResults", prefix, null);
  }
}

/** {@inheritDoc} */
@Override protected void doNativeParse(@Nonnull final Element element, @Nonnull final ParserContext parserContext,
    @Nonnull final BeanDefinitionBuilder builder) {
  super.doNativeParse(element, parserContext, builder);
  
  DeprecationSupport.warn(ObjectType.XSITYPE, SCHEMA_TYPE_AFP.toString(),
      parserContext.getReaderContext().getResource().getDescription(), null);
}

/**
 * Constructor.
 * 
 * @param query to search the database
 * @param timeout search timeout
 * @deprecated - use the property setters
 */
@Deprecated public FormatExecutableStatementBuilder(@Nonnull final String query, @Nonnull final int timeout) {
  DeprecationSupport.warn(ObjectType.METHOD, "FormatExecutableStatementBuilder(String, int)", null, null);
  sqlQuery = Constraint.isNotNull(query, "SQL query can not be null");
  setQueryTimeout((int) Constraint.isGreaterThanOrEqual(0, timeout, "Query timeout must be greater than zero"));
}

/**
 * Creates a new DataSource validator.
 * 
 * @param source to validate
 * @deprecated - use the property setters
 */
@Deprecated public DataSourceValidator(final DataSource source) {
  DeprecationSupport.warn(ObjectType.METHOD, "DataSourceValidator(DataSource)", null, "DataSourceValidator()");
  dataSource = source;
  try {
    initialize();
  } catch (final ComponentInitializationException e) {
    throw new ConstraintViolationException("Invalid parameterization.");
  }
}

/** {@inheritDoc} */
@Override protected void doParse(final Element element, final ParserContext parserContext,
    final BeanDefinitionBuilder builder) {
   DeprecationSupport.warn(ObjectType.XSITYPE, TYPE_NAME.toString(),
      parserContext.getReaderContext().getResource().getDescription(), null);
  
  final List<Element> children =
      ElementSupport.getChildElements(element, AbstractMetadataProviderParser.METADATA_FILTER_ELEMENT_NAME);
  if (null != children && !children.isEmpty()) {
    builder.addPropertyValue("filters", SpringSupport.parseCustomElements(children, parserContext));
  }
}

/**
 * Creates a new DataSource validator.
 * 
 * @param source to validate
 * @param throwOnError whether {@link #validate()} should throw or log errors
 * @deprecated - use the property setters
 */
@Deprecated public DataSourceValidator(final DataSource source, final boolean throwOnError) {
  DeprecationSupport.warn(ObjectType.METHOD, "DataSourceValidator(DataSource, boolean)",
      null, "DataSourceValidator()");
  dataSource = source;
  throwOnValidateError = throwOnError;
  try {
    initialize();
  } catch (final ComponentInitializationException e) {
    throw new ConstraintViolationException("Invalid parameterization.");
  }
}

/** {@inheritDoc} */
@Override protected void doParse(final Element element, final ParserContext parserContext,
    final BeanDefinitionBuilder builder) {
  final List<Element> schemaNameElements = ElementSupport.getChildElements(element, EXTENSION_SCHEMA_NAME);
  if (element.hasAttributeNS(null, "schemaBuilderRef")) {
    builder.addConstructorArgReference(StringSupport.trimOrNull(element
        .getAttributeNS(null, "schemaBuilderRef")));
  } else {
    builder.addConstructorArgReference("shibboleth.SchemaBuilder");
  }
  if (null != schemaNameElements && !schemaNameElements.isEmpty()) {
    DeprecationSupport.warn(ObjectType.ELEMENT, "ExtensionSchema", null, null);
    builder.addConstructorArgValue(SpringSupport.getElementTextContentAsManagedList(schemaNameElements));
  }
}

/**
 * Constructor.
 * 
 * @param filter used for the LDAP search
 * @deprecated - use the property setters
 */
@Deprecated public ParameterizedExecutableSearchFilterBuilder(@Nonnull final String filter) {
  DeprecationSupport.warn(ObjectType.METHOD, "ParameterizedExecutableSearchFilterBuilder(String)",
      null, "ParameterizedExecutableSearchFilterBuilder()");
  setSearchFilter(filter);
  try {
    initialize();
  } catch (final ComponentInitializationException e) {
    throw new ConstraintViolationException("Invalid parameterization.");
  }
}

/** Factory used to generate a specific Connector. 
 * @param activationCondition - the activationCondition
 * @return an appropriate FlowDescriptor 
 */
public static SubjectCanonicalizationFlowDescriptor c14LegacyPrincipalConnectorFactory(
      @ParameterName(name="activationCondition") Predicate<ProfileRequestContext> activationCondition)
{
  DeprecationSupport.warn(ObjectType.BEAN, "c14n/LegacyPrincipalConnector", "c14n/subject-c14n.xml", "<remove>");
  final SubjectCanonicalizationFlowDescriptor result = new SubjectCanonicalizationFlowDescriptor ();
  result.setActivationCondition(activationCondition);
  return result;
}