Package com.fifa.connectid.sdk.core

Class FifaConnectIdClientImpl

java.lang.Object

com.fifa.connectid.sdk.core.FifaConnectIdClientImpl

All Implemented Interfaces:

FifaConnectIdClient

public class FifaConnectIdClientImpl
extends Object
implements FifaConnectIdClient

Client used to make request to FIFA Connect ID service. One instance allows to make multiple requests. This class is not thread safe.

Constructor Summary

Constructors

Constructor	Description
FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment, com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials, com.fifa.connectservicebus.sdk.logging.Logger logger)
FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment, com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials, com.fifa.connectservicebus.sdk.logging.Logger logger, ActorResolver actorResolver)
FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment, com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials, com.fifa.connectservicebus.sdk.logging.Logger logger, ActorResolver actorResolver, com.fifa.connectservicebus.sdk.ProxySettings proxySettings)
FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment, com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials, com.fifa.connectservicebus.sdk.logging.Logger logger, ActorResolver actorResolver, com.fifa.connectservicebus.sdk.ProxySettings proxySettings, ExecutorService executorService)
FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment, com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials, com.fifa.connectservicebus.sdk.logging.Logger logger, ActorResolver actorResolver, com.fifa.connectservicebus.sdk.ProxySettings proxySettings, ExecutorService executorService, HashedPersonProcessor hashedPersonProcessor)
FifaConnectIdClientImpl(HashingServiceClient hashingServiceClient, IdDirectoryServiceClient idDirectoryServiceClient, com.fifa.connectservicebus.sdk.logging.Logger logger)

Method Summary

Modifier and Type	Method	Description
PersonType	addRegistrations(AddRegistrationsRequestType request, Boolean force)	Adds person registrations
BulkDeactivateRegistrationsResponseType	bulkDeactivateRegistrations(BulkDeactivateRegistrationsRequestType request)	Bulk deactivate registrations given in request.
FindFacilitiesResponseType	findFacilities(FindFacilitiesRequestType request)	Searches for facilities.
FindOrganisationsResponseType	findOrganisations(FindOrganisationsRequestType request)	Searches for organisations.
String	forceRegisterPerson(PersonData personData)	Registers a new person even if possible duplicates are found.
String	forceRegisterPerson(PersonData personData, String personLocalId)	Registers a new person even if possible duplicates are found.
NationalAssociationsOnboardedResponseType	getAllNationalAssociationsOnboardedStatus()	Asks Connect ID if specific organisation is onboarded.
List<String>	getDataHoldersOfPerson(String personFifaId)	Gets systems registered as Data Holder for the given person
FacilityLocalType	getFacility(String facilityFifaId)	Gets facility data associated with the specified FIFA Unique Identifier.
List<FacilityLocalType>	getFacilityDuplicates(FacilityLocalType facility)	Gets a list of facilities this facility may be duplicated with.
HashingServiceClient	getHashingClient()	Returns current instance of HashingClient
IdDirectoryServiceClient	getIdDirectoryClient()	Returns current instance of IdDirectoryClient
MemberAssociationResponseType	getMemberAssociationForFifaId(String organisationFifaId)	Gets FIFA Id and short name of the Member Association the searched organisation belongs to.
List<String>	getMergedSecondaryFifaIdsForPerson(String personFifaId)	Gets secondary FIFA IDs directly merged into person
NationalAssociationsOnboardedResponseType	getNationalAssociationsOnboardedStatus(NationalAssociationsOnboardedRequestType request)	Asks Connect ID if specific organisation is onboarded.
OrganisationLocalType	getOrganisation(String organisationFifaId)	Gets organisation data associated with the specified FIFA Unique Identifier.
List<OrganisationLocalType>	getOrganisationDuplicates(OrganisationLocalType organisation)	Gets a list of organisations this organisation may be duplicated with.
PersonType	getPerson(String personFifaId)	Gets person data associated with the specified FIFA Unique Identifier.
List<PersonDuplicateType>	getPersonDuplicates(PersonData personData)	Gets a list of people this person may be duplicated with.
List<PersonDuplicateType>	getPersonDuplicates(PersonData personData, List<String> organisationsIds)	Gets a list of people this person may be duplicated with.
GetDuplicatesOfRegisteredPersonResponseType	getPersonDuplicatesExceptTrustedKnownDuplicates(String personFifaId, List<String> trustedOrganisationsIds)	Gets a list of people this person may be duplicated with.
RegistrationType	getPrimaryDataProviderRegistrationType(String personFifaId)	Gets registration belonging to the primary data provider of the person with the specified FIFA Unique Identifier.
OrganisationLocalType	mergeOrganisations(String primaryOrganisationFifaId, String secondaryOrganisationFifaId)	Merges two organisations.
PersonType	mergePersons(String primaryPersonId, String secondaryPersonId)	Merges two persons.
void	registerAsDataHolderOfPerson(String personFifaId)	Registers current system as Data Holder for the given person
String	registerFacility(FacilityLocalType facility)	Registers a new facility and assigns FIFA Unique Identifier.
String	registerFacility(FacilityLocalType facility, Boolean force)	Registers a new facility and assigns FIFA Unique Identifier.
String	registerOrganisation(OrganisationLocalType organisation)	Registers a new organisation and assigns FIFA Unique Identifier.
String	registerOrganisation(OrganisationLocalType organisation, Boolean force)	Registers a new organisation and assigns FIFA Unique Identifier.
String	registerPerson(PersonData personData)	Registers a new person and assigns FIFA Unique Identifier.
String	registerPerson(PersonData personData, String peronLocalId)	Registers a new person and assigns FIFA Unique Identifier.
OrganisationLocalType	unmergeOrganisations(String primaryOrganisationFifaId, String secondaryOrganisationFifaId)	Reverts merge operation.
PersonType	unmergePersons(String primaryPersonId, String secondaryPersonId)	Reverts merge operation.
FacilityLocalType	updateFacility(FacilityLocalType facility)	Updates the facility.
FacilityLocalType	updateFacility(FacilityLocalType facility, Boolean force)	Updates the facility.
OrganisationLocalType	updateOrganisation(OrganisationLocalType organisation)	Updates the organisation.
OrganisationLocalType	updateOrganisation(OrganisationLocalType organisation, Boolean force)	Updates the organisation.
PersonType	updatePerson(String personId, List<PersonName> names, org.joda.time.LocalDate dateOfBirth, boolean force)	Updates person data.
PersonType	updatePerson(String personId, List<PersonName> names, org.joda.time.LocalDate dateOfBirth, String gender, boolean force)	Updates person data.
PersonType	updateRegistrations(UpdateRegistrationsRequestType request, Boolean force)	Updates person registrations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(HashingServiceClient hashingServiceClient,
                               IdDirectoryServiceClient idDirectoryServiceClient,
                               com.fifa.connectservicebus.sdk.logging.Logger logger)

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment,
                               com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials,
                               com.fifa.connectservicebus.sdk.logging.Logger logger,
                               ActorResolver actorResolver,
                               com.fifa.connectservicebus.sdk.ProxySettings proxySettings,
                               ExecutorService executorService,
                               HashedPersonProcessor hashedPersonProcessor)

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment,
                               com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials,
                               com.fifa.connectservicebus.sdk.logging.Logger logger,
                               ActorResolver actorResolver,
                               com.fifa.connectservicebus.sdk.ProxySettings proxySettings,
                               ExecutorService executorService)

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment,
                               com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials,
                               com.fifa.connectservicebus.sdk.logging.Logger logger,
                               ActorResolver actorResolver,
                               com.fifa.connectservicebus.sdk.ProxySettings proxySettings)

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment,
                               com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials,
                               com.fifa.connectservicebus.sdk.logging.Logger logger,
                               ActorResolver actorResolver)

FifaConnectIdClientImpl

public FifaConnectIdClientImpl(ConnectIdEnvironment connectIdEnvironment,
                               com.fifa.connectservicebus.sdk.authentication.ClientCredentials clientCredentials,
                               com.fifa.connectservicebus.sdk.logging.Logger logger)

Method Detail

getPerson

public PersonType getPerson(String personFifaId)
                     throws FifaConnectIdException,
                            com.fifa.connectservicebus.sdk.AuthenticationException,
                            ValidationException

Gets person data associated with the specified FIFA Unique Identifier.

Specified by:

getPerson in interface FifaConnectIdClient

Parameters:

personFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

FifaPersonMergedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getPrimaryDataProviderRegistrationType

public RegistrationType getPrimaryDataProviderRegistrationType(String personFifaId)
                                                        throws FifaConnectIdException,
                                                               com.fifa.connectservicebus.sdk.AuthenticationException,
                                                               ValidationException

Gets registration belonging to the primary data provider of the person with the specified FIFA Unique Identifier.

Specified by:

getPrimaryDataProviderRegistrationType in interface FifaConnectIdClient

Parameters:

personFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

FifaPersonMergedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getPersonDuplicates

public List<PersonDuplicateType> getPersonDuplicates(PersonData personData)
                                              throws FifaConnectIdException,
                                                     com.fifa.connectservicebus.sdk.AuthenticationException,
                                                     ValidationException

Gets a list of people this person may be duplicated with. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

getPersonDuplicates in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getPersonDuplicates

public List<PersonDuplicateType> getPersonDuplicates(PersonData personData,
                                                     List<String> organisationsIds)
                                              throws FifaConnectIdException,
                                                     com.fifa.connectservicebus.sdk.AuthenticationException,
                                                     ValidationException

Gets a list of people this person may be duplicated with. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

getPersonDuplicates in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

organisationsIds - - organisations' FIFA Unique Identifiers

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getPersonDuplicatesExceptTrustedKnownDuplicates

public GetDuplicatesOfRegisteredPersonResponseType getPersonDuplicatesExceptTrustedKnownDuplicates(String personFifaId,
                                                                                                   List<String> trustedOrganisationsIds)
                                                                                            throws FifaConnectIdException,
                                                                                                   com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                                   ValidationException

Gets a list of people this person may be duplicated with. Duplicates marked as known duplicate by trusted organisations would not be returned.

Specified by:

getPersonDuplicatesExceptTrustedKnownDuplicates in interface FifaConnectIdClient

Parameters:

personFifaId - - Person FIFA Unique Identifier.

trustedOrganisationsIds - - Trusted organisations' FIFA Unique Identifiers.

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getOrganisationDuplicates

public List<OrganisationLocalType> getOrganisationDuplicates(OrganisationLocalType organisation)
                                                      throws FifaConnectIdException,
                                                             com.fifa.connectservicebus.sdk.AuthenticationException,
                                                             ValidationException

Gets a list of organisations this organisation may be duplicated with. Uses 'OrganisationLocal' as defined in FIFA Data Standard.

Specified by:

getOrganisationDuplicates in interface FifaConnectIdClient

Parameters:

organisation - - object containing information about organisation

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getFacilityDuplicates

public List<FacilityLocalType> getFacilityDuplicates(FacilityLocalType facility)
                                              throws FifaConnectIdException,
                                                     com.fifa.connectservicebus.sdk.AuthenticationException,
                                                     ValidationException

Gets a list of facilities this facility may be duplicated with. Uses 'FacilityType' as defined in FIFA Data Standard.

Specified by:

getFacilityDuplicates in interface FifaConnectIdClient

Parameters:

facility - - object containing information about facility

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerPerson

public String registerPerson(PersonData personData)
                      throws FifaConnectIdException,
                             com.fifa.connectservicebus.sdk.AuthenticationException,
                             ValidationException

Registers a new person and assigns FIFA Unique Identifier. If duplicates are found the person is not registered. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

registerPerson in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaDuplicatedPersonFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerPerson

public String registerPerson(PersonData personData,
                             String peronLocalId)
                      throws FifaConnectIdException,
                             com.fifa.connectservicebus.sdk.AuthenticationException,
                             ValidationException

Registers a new person and assigns FIFA Unique Identifier. If duplicates are found the person is not registered. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

registerPerson in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaDuplicatedPersonFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

forceRegisterPerson

public String forceRegisterPerson(PersonData personData)
                           throws FifaConnectIdException,
                                  com.fifa.connectservicebus.sdk.AuthenticationException,
                                  ValidationException

Registers a new person even if possible duplicates are found. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

forceRegisterPerson in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

forceRegisterPerson

public String forceRegisterPerson(PersonData personData,
                                  String personLocalId)
                           throws FifaConnectIdException,
                                  com.fifa.connectservicebus.sdk.AuthenticationException,
                                  ValidationException

Registers a new person even if possible duplicates are found. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Specified by:

forceRegisterPerson in interface FifaConnectIdClient

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

personLocalId - - Local identifier of person

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updatePerson

public PersonType updatePerson(String personId,
                               List<PersonName> names,
                               org.joda.time.LocalDate dateOfBirth,
                               boolean force)
                        throws com.fifa.connectservicebus.sdk.AuthenticationException,
                               FifaConnectIdException,
                               ValidationException

Updates person data.

Specified by:

updatePerson in interface FifaConnectIdClient

Parameters:

personId - Fifa Identifier of person

names - Person names that need to be updated

dateOfBirth - Person date of birth that need to be updated

force - - when set to true updates a person even if possible duplicates are found

Throws:

com.fifa.connectservicebus.sdk.AuthenticationException

InvalidClientDataException

FifaDuplicateOfRegisteredPersonFoundException

FifaConnectIdException

FifaEntityNotFoundException

UnauthorizedException

TooManyRequestsException

ValidationException

updatePerson

public PersonType updatePerson(String personId,
                               List<PersonName> names,
                               org.joda.time.LocalDate dateOfBirth,
                               String gender,
                               boolean force)
                        throws com.fifa.connectservicebus.sdk.AuthenticationException,
                               FifaConnectIdException,
                               ValidationException

Updates person data.

Specified by:

updatePerson in interface FifaConnectIdClient

Parameters:

personId - Fifa Identifier of person

names - Person names that need to be updated

dateOfBirth - Person date of birth that need to be updated

gender - Sex of a person

force - - when set to true updates a person even if possible duplicates are found

Throws:

com.fifa.connectservicebus.sdk.AuthenticationException

InvalidClientDataException

FifaDuplicateOfRegisteredPersonFoundException

FifaConnectIdException

FifaEntityNotFoundException

UnauthorizedException

TooManyRequestsException

ValidationException

addRegistrations

public PersonType addRegistrations(AddRegistrationsRequestType request,
                                   Boolean force)
                            throws FifaConnectIdException,
                                   com.fifa.connectservicebus.sdk.AuthenticationException,
                                   ValidationException

Adds person registrations

Specified by:

addRegistrations in interface FifaConnectIdClient

Parameters:

request - - object containing registration information

force - - when set to true validation of acting organisation will not be checked.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updateRegistrations

public PersonType updateRegistrations(UpdateRegistrationsRequestType request,
                                      Boolean force)
                               throws FifaConnectIdException,
                                      com.fifa.connectservicebus.sdk.AuthenticationException,
                                      ValidationException

Updates person registrations

Specified by:

updateRegistrations in interface FifaConnectIdClient

Parameters:

request - - object containing registration information

force - - when set to true validation of acting organisation will not be checked.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getOrganisation

public OrganisationLocalType getOrganisation(String organisationFifaId)
                                      throws FifaConnectIdException,
                                             com.fifa.connectservicebus.sdk.AuthenticationException,
                                             ValidationException

Gets organisation data associated with the specified FIFA Unique Identifier.

Specified by:

getOrganisation in interface FifaConnectIdClient

Parameters:

organisationFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaOrganisationMergedException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerOrganisation

public String registerOrganisation(OrganisationLocalType organisation,
                                   Boolean force)
                            throws FifaConnectIdException,
                                   com.fifa.connectservicebus.sdk.AuthenticationException,
                                   ValidationException

Registers a new organisation and assigns FIFA Unique Identifier. Uses organisation data as defined in FIFA Data Standard.

Specified by:

registerOrganisation in interface FifaConnectIdClient

Parameters:

organisation - - object containing information about the organisation.

force - - force register organisation

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerOrganisation

public String registerOrganisation(OrganisationLocalType organisation)
                            throws FifaConnectIdException,
                                   com.fifa.connectservicebus.sdk.AuthenticationException,
                                   ValidationException

Registers a new organisation and assigns FIFA Unique Identifier. Uses organisation data as defined in FIFA Data Standard.

Specified by:

registerOrganisation in interface FifaConnectIdClient

Parameters:

organisation - - object containing information about the organisation.

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

mergePersons

public PersonType mergePersons(String primaryPersonId,
                               String secondaryPersonId)
                        throws FifaConnectIdException,
                               com.fifa.connectservicebus.sdk.AuthenticationException,
                               ValidationException

Merges two persons. Returns the primary person.

Specified by:

mergePersons in interface FifaConnectIdClient

Parameters:

primaryPersonId - Primary person FIFA Unique Identifier

secondaryPersonId - Secondary person FIFA Unique Identifier

Throws:

FifaConnectIdException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

unmergePersons

public PersonType unmergePersons(String primaryPersonId,
                                 String secondaryPersonId)
                          throws FifaConnectIdException,
                                 com.fifa.connectservicebus.sdk.AuthenticationException,
                                 ValidationException

Reverts merge operation. Returns the secondary person which will be active again when unmerge operations is completed.

Specified by:

unmergePersons in interface FifaConnectIdClient

Parameters:

primaryPersonId - Primary person FIFA Unique Identifier

secondaryPersonId - Secondary person FIFA Unique Identifier

Throws:

FifaConnectIdException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

bulkDeactivateRegistrations

public BulkDeactivateRegistrationsResponseType bulkDeactivateRegistrations(BulkDeactivateRegistrationsRequestType request)
                                                                    throws FifaConnectIdException,
                                                                           com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                           ValidationException

Bulk deactivate registrations given in request.

Specified by:

bulkDeactivateRegistrations in interface FifaConnectIdClient

Throws:

FifaConnectIdException

InvalidClientDataException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

mergeOrganisations

public OrganisationLocalType mergeOrganisations(String primaryOrganisationFifaId,
                                                String secondaryOrganisationFifaId)
                                         throws FifaConnectIdException,
                                                com.fifa.connectservicebus.sdk.AuthenticationException,
                                                ValidationException

Merges two organisations. Returns the primary organisation.

Specified by:

mergeOrganisations in interface FifaConnectIdClient

Parameters:

primaryOrganisationFifaId - Primary organisation FIFA Unique Identifier

secondaryOrganisationFifaId - Secondary organisation FIFA Unique Identifier

Throws:

FifaConnectIdException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

unmergeOrganisations

public OrganisationLocalType unmergeOrganisations(String primaryOrganisationFifaId,
                                                  String secondaryOrganisationFifaId)
                                           throws FifaConnectIdException,
                                                  com.fifa.connectservicebus.sdk.AuthenticationException,
                                                  ValidationException

Reverts merge operation. Returns the secondary organisation when unmerge operations is completed.

Specified by:

unmergeOrganisations in interface FifaConnectIdClient

Parameters:

primaryOrganisationFifaId - Primary organisation FIFA Unique Identifier

secondaryOrganisationFifaId - Secondary organisation FIFA Unique Identifier

Throws:

FifaConnectIdException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updateOrganisation

public OrganisationLocalType updateOrganisation(OrganisationLocalType organisation,
                                                Boolean force)
                                         throws FifaConnectIdException,
                                                com.fifa.connectservicebus.sdk.AuthenticationException,
                                                ValidationException

Updates the organisation.

Specified by:

updateOrganisation in interface FifaConnectIdClient

Parameters:

organisation - Object containing information about the organisation to update

force - - force update organisation

Throws:

FifaConnectIdException

InvalidClientDataException

FifaEntityNotFoundException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updateOrganisation

public OrganisationLocalType updateOrganisation(OrganisationLocalType organisation)
                                         throws FifaConnectIdException,
                                                com.fifa.connectservicebus.sdk.AuthenticationException,
                                                ValidationException

Updates the organisation.

Specified by:

updateOrganisation in interface FifaConnectIdClient

Parameters:

organisation - Object containing information about the organisation to update

Throws:

FifaConnectIdException

InvalidClientDataException

FifaEntityNotFoundException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getFacility

public FacilityLocalType getFacility(String facilityFifaId)
                              throws FifaConnectIdException,
                                     com.fifa.connectservicebus.sdk.AuthenticationException,
                                     ValidationException

Gets facility data associated with the specified FIFA Unique Identifier.

Specified by:

getFacility in interface FifaConnectIdClient

Parameters:

facilityFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerFacility

public String registerFacility(FacilityLocalType facility,
                               Boolean force)
                        throws FifaConnectIdException,
                               com.fifa.connectservicebus.sdk.AuthenticationException,
                               ValidationException

Registers a new facility and assigns FIFA Unique Identifier. Uses facility data as defined in FIFA Data Standard.

Specified by:

registerFacility in interface FifaConnectIdClient

Parameters:

facility - - object containing information about the facility.

force - - force register facility

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedFacilityFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerFacility

public String registerFacility(FacilityLocalType facility)
                        throws FifaConnectIdException,
                               com.fifa.connectservicebus.sdk.AuthenticationException,
                               ValidationException

Registers a new facility and assigns FIFA Unique Identifier. Uses facility data as defined in FIFA Data Standard.

Specified by:

registerFacility in interface FifaConnectIdClient

Parameters:

facility - - object containing information about the facility.

Throws:

InvalidClientDataException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedFacilityFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updateFacility

public FacilityLocalType updateFacility(FacilityLocalType facility,
                                        Boolean force)
                                 throws FifaConnectIdException,
                                        com.fifa.connectservicebus.sdk.AuthenticationException,
                                        ValidationException

Updates the facility.

Specified by:

updateFacility in interface FifaConnectIdClient

Parameters:

facility - Object containing information about the facility.

force - - force update facility

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedFacilityFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

updateFacility

public FacilityLocalType updateFacility(FacilityLocalType facility)
                                 throws FifaConnectIdException,
                                        com.fifa.connectservicebus.sdk.AuthenticationException,
                                        ValidationException

Updates the facility.

Specified by:

updateFacility in interface FifaConnectIdClient

Parameters:

facility - Object containing information about the facility.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

FifaDuplicatedFacilityFoundException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

findOrganisations

public FindOrganisationsResponseType findOrganisations(FindOrganisationsRequestType request)
                                                throws FifaConnectIdException,
                                                       IOException,
                                                       com.fifa.connectservicebus.sdk.AuthenticationException,
                                                       ValidationException

Searches for organisations.

Specified by:

findOrganisations in interface FifaConnectIdClient

Parameters:

request - - >Object containing search criteria

Returns:

FindOrganisationsResponseType - Object containing a list of found organisations

Throws:

FifaConnectIdException

TooManyRequestsException

IOException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

findFacilities

public FindFacilitiesResponseType findFacilities(FindFacilitiesRequestType request)
                                          throws FifaConnectIdException,
                                                 IOException,
                                                 com.fifa.connectservicebus.sdk.AuthenticationException,
                                                 ValidationException

Searches for facilities.

Specified by:

findFacilities in interface FifaConnectIdClient

Parameters:

request - - Object containing search criteria

Returns:

FindFacilitiesResponseType - Object containing a list of found facilities

Throws:

FifaConnectIdException

TooManyRequestsException

IOException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

getAllNationalAssociationsOnboardedStatus

public NationalAssociationsOnboardedResponseType getAllNationalAssociationsOnboardedStatus()
                                                                                    throws IOException,
                                                                                           com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                           FifaConnectIdException

Asks Connect ID if specific organisation is onboarded.

Specified by:

getAllNationalAssociationsOnboardedStatus in interface FifaConnectIdClient

Returns:

NationalAssociationsOnboardedResponseType - Object containing list of all national associations fifa identifiers and corresponding onboarded statuses.

Throws:

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaConnectIdException

TooManyRequestsException

IOException

getNationalAssociationsOnboardedStatus

public NationalAssociationsOnboardedResponseType getNationalAssociationsOnboardedStatus(NationalAssociationsOnboardedRequestType request)
                                                                                 throws IOException,
                                                                                        com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                        FifaConnectIdException,
                                                                                        ValidationException

Asks Connect ID if specific organisation is onboarded.

Specified by:

getNationalAssociationsOnboardedStatus in interface FifaConnectIdClient

Parameters:

request - - Object containing list of national association identifiers

Returns:

NationalAssociationsOnboardedResponseType - Object containing list of national associations fifa identifiers and corresponding onboarded statuses.

Throws:

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaEntityNotFoundException

InvalidClientDataException

FifaConnectIdException

TooManyRequestsException

ValidationException

IOException

getMemberAssociationForFifaId

public MemberAssociationResponseType getMemberAssociationForFifaId(String organisationFifaId)
                                                            throws FifaConnectIdException,
                                                                   com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                   ValidationException

Gets FIFA Id and short name of the Member Association the searched organisation belongs to.

Specified by:

getMemberAssociationForFifaId in interface FifaConnectIdClient

Returns:

MemberAssociationResponseType

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

UnauthorizedException

TooManyRequestsException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

registerAsDataHolderOfPerson

public void registerAsDataHolderOfPerson(String personFifaId)
                                  throws ValidationException,
                                         com.fifa.connectservicebus.sdk.AuthenticationException,
                                         UnauthorizedException,
                                         InvalidClientDataException,
                                         FifaPersonMergedException,
                                         FifaEntityNotFoundException,
                                         FifaEntityDeletedException,
                                         FifaConnectIdException

Registers current system as Data Holder for the given person

Specified by:

registerAsDataHolderOfPerson in interface FifaConnectIdClient

Parameters:

personFifaId - Person FIFA Unique Identifier

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaPersonMergedException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getDataHoldersOfPerson

public List<String> getDataHoldersOfPerson(String personFifaId)
                                    throws ValidationException,
                                           com.fifa.connectservicebus.sdk.AuthenticationException,
                                           UnauthorizedException,
                                           InvalidClientDataException,
                                           FifaPersonMergedException,
                                           FifaEntityNotFoundException,
                                           FifaEntityDeletedException,
                                           FifaConnectIdException

Gets systems registered as Data Holder for the given person

Specified by:

getDataHoldersOfPerson in interface FifaConnectIdClient

Parameters:

personFifaId - Person FIFA Unique Identifier

Returns:

List of data holders

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaPersonMergedException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getMergedSecondaryFifaIdsForPerson

public List<String> getMergedSecondaryFifaIdsForPerson(String personFifaId)
                                                throws ValidationException,
                                                       com.fifa.connectservicebus.sdk.AuthenticationException,
                                                       FifaConnectIdException

Gets secondary FIFA IDs directly merged into person

Specified by:

getMergedSecondaryFifaIdsForPerson in interface FifaConnectIdClient

Parameters:

personFifaId - Person FIFA Unique Identifier

Returns:

List of merged secondary FIFA IDs

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getHashingClient

public HashingServiceClient getHashingClient()

Returns current instance of HashingClient

Specified by:

getHashingClient in interface FifaConnectIdClient

getIdDirectoryClient

public IdDirectoryServiceClient getIdDirectoryClient()

Returns current instance of IdDirectoryClient

Specified by:

getIdDirectoryClient in interface FifaConnectIdClient