SAMLPartner (Oracle WebLogic Server API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.security.providers.saml.registry
Interface SAMLPartner

All Known Subinterfaces:: SAMLAssertingParty, SAMLCommonPartner, SAMLRelyingParty

public interface SAMLPartner

Abstract representation of a SAML partner.

Note that this Javadoc is being made available for the purposes of using the WebLogic Scripting Tool (WLST) to configure SAML 1.1 partners. This interface does not have a supported Java programming interface.

Method Summary
`String`	`getDescription()` Get the Description for this partner.
`String`	`getPartnerId()` Get this partner's Partner ID.
`boolean`	`isEnabled()` Get the Enabled value for this partner.
`void`	`setDescription(String desc)` Set the Description for this partner.
`void`	`setEnabled(boolean enabled)` Set the Enabled value for this partner.
`void`	`validate()` Validate this partner.

Method Detail

getPartnerId

String getPartnerId()

Get this partner's Partner ID.

Returns:: The Partner ID.

isEnabled

boolean isEnabled()

Get the Enabled value for this partner. This value indicates whether the partner is enabled or not.

Returns:: The Enabled value.

setEnabled

void setEnabled(boolean enabled)

Set the Enabled value for this partner.

Parameters:: enabled - The Enabled value to set.

getDescription

String getDescription()

Get the Description for this partner.

Returns:: The Description.

setDescription

void setDescription(String desc)

Set the Description for this partner.

Parameters:: desc - The Description value to set.

validate

void validate()
              throws weblogic.management.utils.InvalidParameterException

Validate this partner. If the partner is not enabled, this method does nothing. For enabled partners, this method validates the partner's settings with respect to the configured SAML profile.

Throws:: weblogic.management.utils.InvalidParameterException